express-generator-typescript 2.5.17 → 2.5.18

package/lib/project-files/package.json

@@ -26,7 +26,7 @@
     "jet-env": "^1.1.4",
     "jet-logger": "^2.0.1",
     "jet-paths": "^1.1.0",
-    "jet-validators": "^1.2.1",
+    "jet-validators": "^1.3.3",
     "jsonfile": "^6.1.0",
     "module-alias": "^2.2.2",
     "morgan": "^1.10.0"

package/lib/project-files/spec/support/index.ts

@@ -1,5 +1,7 @@
 import { Response } from 'supertest';
 import UserRepo from '@src/repos/UserRepo';
+import { IParseObjectError, parseJson } from 'jet-validators/utils';
+import { isString } from 'jet-validators';
 
 
 /******************************************************************************
@@ -16,6 +18,11 @@ interface IErrObj {
   [key: string]: unknown;
 }
 
+interface IValidationErr {
+  message: string;
+  errors: IParseObjectError[];
+}
+
 
 /******************************************************************************
                                 Functions
@@ -29,3 +36,13 @@ export async function cleanDatabase(): Promise<void> {
     UserRepo.deleteAllUsers(),
   ]);
 }
+
+/**
+ * JSON parse a validation error.
+ */
+export function parseValidationErr(arg: unknown): IValidationErr {
+  if (!isString(arg)) {
+    throw new Error('Not a string');
+  }
+  return parseJson<IValidationErr>(arg);
+}

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

@@ -1,18 +1,18 @@
 import supertest from 'supertest';
 import insertUrlParams from 'inserturlparams';
-import { isObject } from 'jet-validators';
-import { parseJson, customDeepCompare } from 'jet-validators/utils';
+import { customDeepCompare } from 'jet-validators/utils';
 
 import app from '@src/server';
 
 import UserRepo from '@src/repos/UserRepo';
 import User, { IUser } from '@src/models/User';
 import { USER_NOT_FOUND_ERR } from '@src/services/UserService';
-import { IParseRequestError } from '@src/routes/common';
+
 import HttpStatusCodes from '@src/common/HttpStatusCodes';
+import { ValidationError } from '@src/common/route-errors';
 
 import Paths from 'spec/support/Paths';
-import { cleanDatabase, TRes } from 'spec/support';
+import { cleanDatabase, parseValidationErr, TRes } from 'spec/support';
 
 
 /******************************************************************************
@@ -92,10 +92,9 @@ describe('UserRouter', () => {
         .send({ user: null })
         .end((_, res: TRes) => {
           expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
-          const errorObj = parseJson<IParseRequestError>(res.body.error),
-            errItem = errorObj.errors[0];
-          expect(errorObj.message).toBe('Parse request validation failed');
-          expect(isObject(errItem) && errItem.prop === 'user').toBeTruthy();
+          const errorObj = parseValidationErr(res.body.error);
+          expect(errorObj.message).toBe(ValidationError.MESSAGE);
+          expect(errorObj.errors[0].prop).toBe('user');
           done();
         });
     });
@@ -118,19 +117,21 @@ describe('UserRouter', () => {
         });
     });
 
-    // Param missing
+    // Id is the wrong data type
     it('should return a JSON object with an error message and a status code ' +
     `of "${HttpStatusCodes.BAD_REQUEST}" if the user param was missing`,
     done => {
+      const user = User.new();
+      user.id = ('5' as unknown as number);
       agent
         .put(Paths.Users.Update)
-        .send({ user: null })
+        .send({ user })
         .end((_, res: TRes) => {
           expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
-          const errorObj = parseJson<IParseRequestError>(res.body.error),
-            errItem = errorObj.errors[0];
-          expect(errorObj.message).toBe('Parse request validation failed');
-          expect(isObject(errItem) && errItem.prop === 'user').toBeTruthy();
+          const errorObj = parseValidationErr(res.body.error);
+          expect(errorObj.message).toBe(ValidationError.MESSAGE);
+          expect(errorObj.errors[0].prop).toBe('user');
+          expect(errorObj.errors[0].children?.[0].prop).toBe('id');
           done();
         });
     });

package/lib/project-files/src/common/route-errors.ts

@@ -1,8 +1,10 @@
+import { IParseObjectError } from 'jet-validators/utils';
+
 import HttpStatusCodes from '@src/common/HttpStatusCodes';
 
 
 /******************************************************************************
-                              Classes
+                                 Classes
 ******************************************************************************/
 
 /**
@@ -17,3 +19,19 @@ export class RouteError extends Error {
   }
 }
 
+/**
+ * Handle "parseObj" errors.
+ */
+export class ValidationError extends RouteError {
+
+  public static MESSAGE = 'The parseObj() function discovered one or ' + 
+    'more errors.';
+
+  public constructor(errors: IParseObjectError[]) {
+    const msg = JSON.stringify({
+      message: ValidationError.MESSAGE,
+      errors,
+    });
+    super(HttpStatusCodes.BAD_REQUEST, msg);
+  }
+}

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

@@ -1,7 +1,7 @@
 import { isString } from 'jet-validators';
-import { parseObjectPlus, TParser } from 'jet-validators/utils';
+import { parseObject, TParseOnError } from 'jet-validators/utils';
 
-import { isRelationalKey, tranIsDate } from '@src/util/validators';
+import { isRelationalKey, transIsDate } from '@src/util/validators';
 
 
 /******************************************************************************
@@ -35,26 +35,26 @@ export interface IUser {
 /**
  * New user object.
  */
-function newUser(user: Partial<IUser>): IUser {
+function newUser(user?: Partial<IUser>): IUser {
   const retVal = { ...DEFAULT_USER_VALS(), ...user };
   return parseUser(retVal);
 }
 
 /**
- * Validate user object but return type predicate.
+ * Check is a user object.
  */
-function testIsUser(arg: unknown): arg is IUser {
-  return !!parseUser(arg);
+function testUser(arg: unknown, errCb?: TParseOnError): arg is IUser {
+  return !!parseUser(arg, errCb);
 }
 
 /**
  * Validate a user object.
  */
-const parseUser: TParser<IUser> = parseObjectPlus({
+const parseUser = parseObject<IUser>({
   id: isRelationalKey,
   name: isString,
   email: isString,
-  created: tranIsDate,
+  created: transIsDate,
 });
 
 
@@ -64,6 +64,5 @@ const parseUser: TParser<IUser> = parseObjectPlus({
 
 export default {
   new: newUser,
-  parse: parseUser,
-  test: testIsUser,
+  test: testUser,
 } as const;

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

@@ -1 +1 @@
-{"users":[{"id":39386845760,"name":"Bill","created":"2025-03-09T02:38:03.021Z","email":"sean.maxwell@gmail.com"},{"id":232226940074,"name":"John Smith","created":"2025-03-09T02:38:03.021Z","email":"john.smith@gmail.com"},{"id":847602476180,"name":"Gordan Freeman","created":"2025-03-09T02:38:03.021Z","email":"gordan.freeman@gmail.com"}]}
+{"users":[{"id":937353914582,"name":"Bill","created":"2025-03-10T08:02:45.482Z","email":"sean.maxwell@gmail.com"},{"id":564064331076,"name":"John Smith","created":"2025-03-10T08:02:45.482Z","email":"john.smith@gmail.com"},{"id":491773368070,"name":"Gordan Freeman","created":"2025-03-10T08:02:45.482Z","email":"gordan.freeman@gmail.com"}]}

package/lib/project-files/src/routes/common/index.ts

@@ -1,54 +1,28 @@
 import { Response, Request } from 'express';
+import { parseObject, TSchema } from 'jet-validators/utils';
 
-import {
-  ParseObjectError,
-  TParseErrorItem,
-  TSchema,
-  parseObjectPlus,
-} from 'jet-validators/utils';
-
-import HttpStatusCodes from '@src/common/HttpStatusCodes';
-import { RouteError } from '@src/common/route-errors';
+import { ValidationError } from '@src/common/route-errors';
 
 
 /******************************************************************************
-                                Types
+                              Functions
 ******************************************************************************/
 
-type TRecord = Record<string, unknown>;
-export type IReq = Request<TRecord, void, TRecord, TRecord>;
-export type IRes = Response<unknown, TRecord>;
-
-export interface IParseRequestError {
-  message: 'Parse request validation failed';
-  errors: TParseErrorItem[];
+/**
+ * Throw a "ParseObjError" when "parseObject" fails. Also extract a nested 
+ * "ParseObjError" and add it to the nestedErrors array.
+ */
+export function parseReq<U extends TSchema>(schema: U) {
+  return parseObject(schema, errors => {
+    throw new ValidationError(errors);
+  });
 }
 
 
 /******************************************************************************
-                                Functions
+                                Types
 ******************************************************************************/
 
-/**
- * Parse an incoming route request object.
- */
-export function parseReq<U extends TSchema>(schema: U) {
-  const parse = parseObjectPlus(schema);
-  return (arg: unknown) => {
-    let retVal;
-    try {
-      retVal = parse(arg);
-    } catch (err) {
-      if (err instanceof ParseObjectError) {
-        const errObj: IParseRequestError = {
-          message: 'Parse request validation failed',
-          errors: err.getErrors(),
-        };
-        const msg = JSON.stringify(errObj);
-        throw new RouteError(HttpStatusCodes.BAD_REQUEST, msg);
-      }
-      throw err;
-    }
-    return retVal;
-  };
-}
+type TRecord = Record<string, unknown>;
+export type IReq = Request<TRecord, void, TRecord, TRecord>;
+export type IRes = Response<unknown, TRecord>;

package/lib/project-files/src/util/validators.ts

@@ -16,7 +16,7 @@ export function isRelationalKey(arg: unknown): arg is number {
 /**
  * Convert to date object then check is a validate date.
  */
-export const tranIsDate = transform(
+export const transIsDate = transform(
   arg => new Date(arg as string),
   arg => isDate(arg),
 );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-generator-typescript",
-  "version": "2.5.17",
+  "version": "2.5.18",
   "description": "Generate new Express applications similar to express-generate which but sets it up to use TypeScript instead",
   "scripts": {
     "express-generator-typescript": "node bin/cli.js",