express-generator-typescript 2.4.7 → 2.4.10

package/lib/project-files-auth/spec/tests/users.spec.ts

@@ -1,4 +1,4 @@
-import supertest, { Test, Response } from 'supertest';
+import supertest, { Test } from 'supertest';
 import TestAgent from 'supertest/lib/agent';
 import { defaultErrMsg as ValidatorErr } from 'jet-validator';
 import insertUrlParams from 'inserturlparams';
@@ -10,225 +10,181 @@ import User, { IUser } from '@src/models/User';
 import HttpStatusCodes from '@src/constants/HttpStatusCodes';
 import { USER_NOT_FOUND_ERR } from '@src/services/UserService';
 
-import login from '../support/login';
 import Paths from 'spec/support/Paths';
-import { TReqBody } from 'spec/support/types';
+import apiCb from 'spec/support/apiCb';
+import login from 'spec/support/login';
+import { TApiCb } from 'spec/types/misc';
 
 
-// **** Variables **** //
-
-// StatusCodes
-const {
-  OK,
-  CREATED,
-  NOT_FOUND,
-  BAD_REQUEST,
-} = HttpStatusCodes;
-
 // 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;
-
-
-// **** Types **** //
-
-type TRes = Omit<Response, 'body'> & {
-  body: {
-    users: IUser[];
-    error: string;
-  }
+const getDummyUsers = () => {
+  return [
+    User.new('Sean Maxwell', 'sean.maxwell@gmail.com'),
+    User.new('John Smith', 'john.smith@gmail.com'),
+    User.new('Gordan Freeman', 'gordan.freeman@gmail.com'),
+  ];
 };
 
 
-// **** Tests **** //
-
+// Tests
 describe('UserRouter', () => {
 
-  let agent: TestAgent<Test>,
-    jwtCookie: string;
+  let agent: TestAgent<Test>;
 
   // Run before all tests
   beforeAll((done) => {
     agent = supertest.agent(app);
-    login(agent, (cookie: string) => {
-      jwtCookie = cookie;
+    login(agent, cookie => {
+      agent.set('Cookie', cookie);
       done();
     });
   });
 
-  // ** Get all users ** //
+  // Get all users
   describe(`"GET:${Paths.Users.Get}"`, () => {
 
-    const callApi = () => 
+    // Setup API
+    const api = (cb: TApiCb) => 
       agent
         .get(Paths.Users.Get)
-        .set('Cookie', jwtCookie);
+        .end(apiCb(cb));
 
     // Success
     it('should return a JSON object with all the users and a status code ' + 
-    `of "${OK}" if the request was successful.`, (done) => {
+    `of "${HttpStatusCodes.OK}" if the request was successful.`, (done) => {
       // Add spy
-      spyOn(UserRepo, 'getAll').and.resolveTo([...DummyGetAllUsers]);
+      const data = getDummyUsers();
+      spyOn(UserRepo, 'getAll').and.resolveTo(data);
       // Call API
-      callApi()
-        .end((_: Error, res: TRes) => {
-          expect(res.status).toBe(OK);
-          for (let i = 0; i < res.body.users.length; i++) {
-            const user = res.body.users[i];
-            expect(user).toEqual(DummyGetAllUsers[i]);
-          }
-          done();
-        });
+      api(res => {
+        expect(res.status).toBe(HttpStatusCodes.OK);
+        expect(res.body).toEqual({ users: data });
+        done();
+      });
     });
   });
 
   // Test add user
   describe(`"POST:${Paths.Users.Add}"`, () => {
 
-    const ERROR_MSG = `${ValidatorErr}"user".`;
+    const ERROR_MSG = `${ValidatorErr}"user".`,
+      DUMMY_USER = getDummyUsers()[0];
 
-    const callApi = (reqBody: TReqBody) => 
+    // Setup API
+    const callApi = (user: IUser | null, cb: TApiCb) => 
       agent
         .post(Paths.Users.Add)
-        .set('Cookie', jwtCookie)
-        .type('form').send(reqBody);
+        .send({ user })
+        .end(apiCb(cb));
 
     // Test add user success
-    it(`should return a status code of "${CREATED}" if the request was ` + 
-    'successful.', (done) => {
+    it(`should return a status code of "${HttpStatusCodes.CREATED}" if the ` + 
+    'request was successful.', (done) => {
       // Spy
       spyOn(UserRepo, 'add').and.resolveTo();
       // Call api
-      callApi(DummyUserData)
-        .end((_: Error, res: TRes) => {
-          expect(res.status).toBe(CREATED);
-          expect(res.body.error).toBeUndefined();
-          done();
-        });
+      callApi(DUMMY_USER, res => {
+        expect(res.status).toBe(HttpStatusCodes.CREATED);
+        done();
+      });
     });
 
     // Missing param
-    it('should return a JSON object with an error message of ' + 
-    `"${ERROR_MSG}" and a status code of "${BAD_REQUEST}" if the user ` + 
+    it(`should return a JSON object with an error message of "${ERROR_MSG}" ` + 
+    `and a status code of "${HttpStatusCodes.BAD_REQUEST}" if the user ` + 
     'param was missing.', (done) => {
       // Call api
-      callApi({})
-        .end((_: Error, res: TRes) => {
-          expect(res.status).toBe(BAD_REQUEST);
-          expect(res.body.error).toBe(ERROR_MSG);
-          done();
-        });
+      callApi(null, res => {
+        expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
+        expect(res.body.error).toBe(ERROR_MSG);
+        done();
+      });
     });
   });
 
-  // ** Update users ** //
+  // Update users
   describe(`"PUT:${Paths.Users.Update}"`, () => {
 
-    const ERROR_MSG = `${ValidatorErr}"user".`;
+    const ERROR_MSG = `${ValidatorErr}"user".`,
+      DUMMY_USER = getDummyUsers()[0];
 
-    const callApi = (reqBody: TReqBody) => 
+    // Setup API
+    const callApi = (user: IUser | null, cb: TApiCb) => 
       agent
         .put(Paths.Users.Update)
-        .set('Cookie', jwtCookie)
-        .type('form').send(reqBody);
+        .send({ user })
+        .end(apiCb(cb));
 
     // Success
-    it(`should return a status code of "${OK}" if the request was successful.`, 
-      (done) => {
-        // Setup spies
-        spyOn(UserRepo, 'update').and.resolveTo();
-        spyOn(UserRepo, 'persists').and.resolveTo(true);
-        // Call api
-        callApi(DummyUserData)
-          .end((_: Error, res: TRes) => {
-            expect(res.status).toBe(OK);
-            expect(res.body.error).toBeUndefined();
-            done();
-          });
+    it(`should return a status code of "${HttpStatusCodes.OK}" if the ` + 
+    'request was successful.', (done) => {
+      // Setup spies
+      spyOn(UserRepo, 'update').and.resolveTo();
+      spyOn(UserRepo, 'persists').and.resolveTo(true);
+      // Call api
+      callApi(DUMMY_USER, res => {
+        expect(res.status).toBe(HttpStatusCodes.OK);
+        done();
       });
+    });
 
     // Param missing
-    it('should return a JSON object with an error message of ' +
-    `"${ERROR_MSG}" and a status code of "${BAD_REQUEST}" if the user ` + 
+    it(`should return a JSON object with an error message of "${ERROR_MSG}" ` +
+    `and a status code of "${HttpStatusCodes.BAD_REQUEST}" if the user ` + 
     'param was missing.', (done) => {
       // Call api
-      callApi({})
-        .end((_: Error, res: TRes) => {
-          expect(res.status).toBe(BAD_REQUEST);
-          expect(res.body.error).toBe(ERROR_MSG);
-          done();
-        });
+      callApi(null, res => {
+        expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
+        expect(res.body.error).toBe(ERROR_MSG);
+        done();
+      });
     });
 
     // User not found
     it('should return a JSON object with the error message of ' + 
-    `"${USER_NOT_FOUND_ERR}" and a status code of "${NOT_FOUND}" if the id ` + 
-    'was not found.', (done) => {
+    `"${USER_NOT_FOUND_ERR}" and a status code of ` + 
+    `"${HttpStatusCodes.NOT_FOUND}" if the id was not found.`, (done) => {
       // Call api
-      callApi(DummyUserData)
-        .end((_: Error, res: TRes) => {
-          expect(res.status).toBe(NOT_FOUND);
-          expect(res.body.error).toBe(USER_NOT_FOUND_ERR);
-          done();
-        });
+      callApi(DUMMY_USER, res => {
+        expect(res.status).toBe(HttpStatusCodes.NOT_FOUND);
+        expect(res.body.error).toBe(USER_NOT_FOUND_ERR);
+        done();
+      });
     });
   });
 
-  // ** Delete user ** //
+  // Delete User
   describe(`"DELETE:${Paths.Users.Delete}"`, () => {
 
-    const VALIDATOR_ERR = `${ValidatorErr}"id".`;
-
-    const callApi = (id: number) => 
+    // Call API
+    const callApi = (id: number, cb: TApiCb) => 
       agent
         .delete(insertUrlParams(Paths.Users.Delete, { id }))
-        .set('Cookie', jwtCookie);
+        .end(apiCb(cb));
 
     // Success
-    it(`should return a status code of "${OK}" if the request was successful.`, 
-      (done) => {
-        // Setup spies
-        spyOn(UserRepo, 'delete').and.resolveTo();
-        spyOn(UserRepo, 'persists').and.resolveTo(true);
-        // Call api
-        callApi(5)
-          .end((_: Error, res: TRes) => {
-            expect(res.status).toBe(OK);
-            expect(res.body.error).toBeUndefined();
-            done();
-          });
+    it(`should return a status code of "${HttpStatusCodes.OK}" if the ` + 
+    'request was successful.', (done) => {
+      // Setup spies
+      spyOn(UserRepo, 'delete').and.resolveTo();
+      spyOn(UserRepo, 'persists').and.resolveTo(true);
+      // Call api
+      callApi(5, res => {
+        expect(res.status).toBe(HttpStatusCodes.OK);
+        done();
       });
+    });
 
     // User not found
     it('should return a JSON object with the error message of ' + 
-    `"${USER_NOT_FOUND_ERR}" and a status code of "${NOT_FOUND}" if the id ` + 
-    'was not found.', (done) => {
-      callApi(-1)
-        .end((_: Error, res: TRes) => {
-          expect(res.status).toBe(NOT_FOUND);
-          expect(res.body.error).toBe(USER_NOT_FOUND_ERR);
-          done();
-        });
-    });
-
-    // Invalid param
-    it(`should return a status code of "${BAD_REQUEST}" and return an error ` + 
-      `message of "${VALIDATOR_ERR}" if the id was not a valid number`, 
-    (done) => {
-      callApi('horse' as unknown as number)
-        .end((_: Error, res: TRes) => {
-          expect(res.status).toBe(BAD_REQUEST);
-          expect(res.body.error).toBe(VALIDATOR_ERR);
-          done();
-        });
+    `"${USER_NOT_FOUND_ERR}" and a status code of ` + 
+    `"${HttpStatusCodes.NOT_FOUND}" if the id was not found.`, done => {
+      // Setup spies
+      callApi(-1, res => {
+        expect(res.status).toBe(HttpStatusCodes.NOT_FOUND);
+        expect(res.body.error).toBe(USER_NOT_FOUND_ERR);
+        done();
+      });
     });
   });
 });

package/lib/project-files-auth/spec/types/misc.ts

@@ -0,0 +1,18 @@
+import { Response } from 'supertest';
+
+import { IUser } from '@src/models/User';
+
+
+// Misc
+export type TReqBody = Record<string, unknown>;
+export type TRes = Omit<Response, 'body'> & { body: TBody };
+export type TApiCb = (res: TRes) => void;
+
+
+// Response Body: Add things to the body here over time to prevent 
+// typescript errors.
+type TBody = {
+  [key: string]: unknown;
+  user?: IUser;
+  users?: IUser[];
+}

package/lib/project-files-auth/src/models/User.ts

@@ -1,7 +1,10 @@
+import moment from 'moment';
+
+
 // **** Variables **** //
 
-const INVALID_CONSTRUCTOR_PARAM = 'nameOrObj arg must a string or an ' + 
-  'object with the appropriate user keys.';
+const INVALID_CONSTRUCTOR_PARAM = 'nameOrObj arg must a string or an object ' + 
+  'with the appropriate user keys.';
 
 export enum UserRoles {
   Standard,
@@ -15,15 +18,15 @@ export interface IUser {
   id: number;
   name: string;
   email: string;
+  created: Date;
+  role: UserRoles;
   pwdHash?: string;
-  role?: UserRoles;
 }
 
 export interface ISessionUser {
   id: number;
   email: string;
   name: string;
-  role: IUser['role'];
 }
 
 
@@ -35,6 +38,7 @@ export interface ISessionUser {
 function new_(
   name?: string,
   email?: string,
+  created?: Date,
   role?: UserRoles,
   pwdHash?: string,
   id?: number, // id last cause usually set by db
@@ -43,8 +47,9 @@ function new_(
     id: (id ?? -1),
     name: (name ?? ''),
     email: (email ?? ''),
+    created: (created ? new Date(created) : new Date()),
     role: (role ?? UserRoles.Standard),
-    pwdHash: (pwdHash ?? ''),
+    ...( pwdHash ? { pwdHash } : {}),
   };
 }
 
@@ -52,13 +57,11 @@ function new_(
  * Get user instance from object.
  */
 function from(param: object): IUser {
-  // Check is user
   if (!isUser(param)) {
     throw new Error(INVALID_CONSTRUCTOR_PARAM);
   }
-  // Get user instance
   const p = param as IUser;
-  return new_(p.name, p.email, p.role, p.pwdHash, p.id);
+  return new_(p.name, p.email, p.created, p.id);
 }
 
 /**
@@ -68,14 +71,16 @@ function isUser(arg: unknown): boolean {
   return (
     !!arg &&
     typeof arg === 'object' &&
-    'id' in arg &&
-    'email' in arg &&
-    'name' in arg &&
-    'role' in arg
+    'id' in arg && typeof arg.id === 'number' && 
+    'email' in arg && typeof arg.email === 'string' && 
+    'name' in arg && typeof arg.name === 'string' &&
+    'created' in arg && moment(arg.created as string | Date).isValid()
   );
 }
 
 
+
+
 // **** Export default **** //
 
 export default {

package/lib/project-files-auth/src/public/scripts/http.js

@@ -1,4 +1,5 @@
 var Http = (() => {
+
   // Setup request for json
   var getOptions = (verb, data) => {
     var options = {
@@ -9,11 +10,12 @@ var Http = (() => {
         'Content-Type': 'application/json',
       },
     };
-    if (data) {
+    if (!!data) {
       options.body = JSON.stringify(data);
     }
     return options;
   };
+
   // Set Http methods
   return {
     get: (path) => fetch(path, getOptions('GET')),

package/lib/project-files-auth/src/public/scripts/login.js

@@ -10,8 +10,6 @@ document.addEventListener('click', (event) => {
     };
     Http
       .post('/api/auth/login', data)
-      .then(() => {
-        window.location.href = '/users';
-      });
+      .then(() => (window.location.href = '/users'));
   }
 }, false);

package/lib/project-files-auth/src/public/scripts/users.js

@@ -1,9 +1,18 @@
-// ***** Start **** //
+// **** Variables **** //
 
-displayUsers();
+const DateFormatter = new Intl.DateTimeFormat('en-US', {
+  year: 'numeric',
+  month: '2-digit',
+  day: '2-digit',
+});
+
+const formatDate = (date) => DateFormatter.format(new Date(date));
 
 
-// ***** Fetch and display users **** //
+// **** Run **** //
+
+// Start
+displayUsers();
 
 /**
  * Call api
@@ -12,59 +21,22 @@ function displayUsers() {
   Http
     .get('/api/users/all')
     .then(resp => resp.json())
-    .then((resp) => {
-      var allUsers = resp.users;
-      // Empty the anchor
+    .then(resp => {
+      var allUsersTemplate = document.getElementById('all-users-template'),
+        allUsersTemplateHtml = allUsersTemplate.innerHTML,
+        template = Handlebars.compile(allUsersTemplateHtml);
       var allUsersAnchor = document.getElementById('all-users-anchor');
-      allUsersAnchor.innerHTML = '';
-      // Append users to anchor
-      allUsers.forEach((user) => {
-        allUsersAnchor.innerHTML += getUserDisplayEle(user);
+      allUsersAnchor.innerHTML = template({
+        users: resp.users.map(user => ({
+          ...user,
+          createdFormatted: formatDate(user.created),
+        })),
       });
     });
 }
 
-/**
- * Get user display element
- */
-function getUserDisplayEle(user) {
-  return (
-    `<div class="user-display-ele">
-
-      <div class="normal-view">
-        <div>Name: ${user.name}</div>
-        <div>Email: ${user.email}</div>
-        <button class="edit-user-btn" data-user-id="${user.id}" data-user-role="${user.role}">
-          Edit
-        </button>
-        <button class="delete-user-btn" data-user-id="${user.id}">
-          Delete
-        </button>
-      </div>
-
-      <div class="edit-view">
-        <div>
-          Name: <input class="name-edit-input" value="${user.name}">
-        </div>
-        <div>
-          Email: <input class="email-edit-input" value="${user.email}">
-        </div>
-        <button class="submit-edit-btn" data-user-id="${user.id}">
-          Submit
-        </button>
-        <button class="cancel-edit-btn" data-user-id="${user.id}">
-          Cancel
-        </button>
-      </div>
-    </div>`
-  );
-}
-
-
-// **** Add, Edit, and Delete Users **** //
-
 // Setup event listener for button click
-document.addEventListener('click', function (event) {
+document.addEventListener('click', event => {
   event.preventDefault();
   var ele = event.target;
   if (ele.matches('#add-user-btn')) {
@@ -93,13 +65,17 @@ function addUser() {
       id: -1,
       name: nameInput.value,
       email: emailInput.value,
-      role: 0,
+      created: new Date(),
     },
   };
   // Call api
   Http
     .post('/api/users/add', data)
-    .then(() => displayUsers());
+    .then(() => {
+      nameInput.value = '';
+      emailInput.value = '';
+      displayUsers();
+    });
 }
 
 /**
@@ -130,13 +106,14 @@ function submitEdit(ele) {
   var nameInput = userEle.getElementsByClassName('name-edit-input')[0];
   var emailInput = userEle.getElementsByClassName('email-edit-input')[0];
   var id = ele.getAttribute('data-user-id');
-  var role = ele.getAttribute('data-user-role');
+  var created = ele.getAttribute('data-user-created');
+    console.log(ele, created)
   var data = {
     user: {
       id: Number(id),
       name: nameInput.value,
       email: emailInput.value,
-      role: Number(role),
+      created: new Date(created),
     },
   };
 	Http
@@ -154,9 +131,6 @@ function deleteUser(ele) {
     .then(() => displayUsers());
 }
 
-
-// **** Logout **** //
-
 function logoutUser() {
   Http
     .get('/api/auth/logout')

package/lib/project-files-auth/src/public/stylesheets/users.css

@@ -22,20 +22,13 @@ body .add-user-col input {
   margin-bottom: 10px;
 }
 
-body .add-user-col #add-user-btn {
-  margin-top: 2px;
-  margin-bottom: 10px;
-}
-
-body .add-user-col #logout-btn {
-  margin-top: 25px;
-  margin-bottom: 10px;
-  font-size: 15px;
-}
-
 
 /** Users Display Column **/
 
+.email-edit {
+  padding-bottom: 8px;
+}
+
 body .users-column .user-display-ele {
   padding-bottom: 10px;
 }

package/lib/project-files-auth/src/repos/UserRepo.ts

@@ -56,7 +56,12 @@ async function update(user: IUser): Promise<void> {
   const db = await orm.openDb();
   for (let i = 0; i < db.users.length; i++) {
     if (db.users[i].id === user.id) {
-      db.users[i] = user;
+      const dbUser = db.users[i];
+      db.users[i] = {
+        ...dbUser,
+        name: user.name,
+        email: user.email,
+      };
       return orm.saveDb(db);
     }
   }

package/lib/project-files-auth/src/repos/database.json

@@ -1 +1 @@
-{"users":[{"name":"Sean Maxwell","email":"sean.maxwell@gmail.com","pwdHash":"$2b$12$1mE2OI9hMS/rgH9Mi0s85OM2V5gzm7aF3gJIWH1y0S1MqVBueyjsy","role":1,"id":159123164363},{"name":"Gordan Freeman","email":"gordan.freeman@halflife.com","pwdHash":"$2b$12$1mE2OI9hMS/rgH9Mi0s85OM2V5gzm7aF3gJIWH1y0S1MqVBueyjsy","role":0,"id":906524522143},{"name":"John Smith","email":"jsmith@yahoo.com","pwdHash":"$2b$12$1mE2OI9hMS/rgH9Mi0s85OM2V5gzm7aF3gJIWH1y0S1MqVBueyjsy","role":0,"id":357437875835}]}
+{"users":[{"name":"Sean Maxwell","email":"sean.maxwell@gmail.com","pwdHash":"$2b$12$1mE2OI9hMS/rgH9Mi0s85OM2V5gzm7aF3gJIWH1y0S1MqVBueyjsy","role":1,"id":159123164363,"created":"2024-03-22T05:20:55.079Z"},{"name":"John Smith","email":"john.smith@yahoo.com","pwdHash":"$2b$12$1mE2OI9hMS/rgH9Mi0s85OM2V5gzm7aF3gJIWH1y0S1MqVBueyjsy","role":0,"id":357437875835,"created":"2024-03-22T05:20:55.079Z"},{"id":28541714318,"name":"Gordan Freeman","email":"nova@prospect.com","created":"2024-03-23T15:56:42.615Z"}]}

package/lib/project-files-auth/src/services/UserService.ts

@@ -31,10 +31,7 @@ function addOne(user: IUser): Promise<void> {
 async function updateOne(user: IUser): Promise<void> {
   const persists = await UserRepo.persists(user.id);
   if (!persists) {
-    throw new RouteError(
-      HttpStatusCodes.NOT_FOUND,
-      USER_NOT_FOUND_ERR,
-    );
+    throw new RouteError(HttpStatusCodes.NOT_FOUND, USER_NOT_FOUND_ERR);
   }
   // Return user
   return UserRepo.update(user);
@@ -46,10 +43,7 @@ async function updateOne(user: IUser): Promise<void> {
 async function _delete(id: number): Promise<void> {
   const persists = await UserRepo.persists(id);
   if (!persists) {
-    throw new RouteError(
-      HttpStatusCodes.NOT_FOUND,
-      USER_NOT_FOUND_ERR,
-    );
+    throw new RouteError(HttpStatusCodes.NOT_FOUND, USER_NOT_FOUND_ERR);
   }
   // Delete user
   return UserRepo.delete(id);