express-generator-typescript 2.7.11 → 2.7.14

package/lib/project-files/src/common/constants/Paths.ts

@@ -1,15 +1,15 @@
-import jetPaths from 'jet-paths';
-
-const Paths = {
-  _: '/api',
-  Users: {
-    _: '/users',
-    Get: '/all',
-    Add: '/add',
-    Update: '/update',
-    Delete: '/delete/:id',
-  },
-} as const;
-
-export const JetPaths = jetPaths(Paths);
-export default Paths;
+import jetPaths from 'jet-paths';
+
+const Paths = {
+  _: '/api',
+  Users: {
+    _: '/users',
+    Get: '/all',
+    Add: '/add',
+    Update: '/update',
+    Delete: '/delete/:id',
+  },
+} as const;
+
+export const JetPaths = jetPaths(Paths);
+export default Paths;

package/lib/project-files/src/common/constants/{EnvVars.ts → env.ts}

@@ -1,19 +1,28 @@
-import jetEnv, { num } from 'jet-env';
-import { isValueOf } from 'jet-validators';
-
-import { NodeEnvs } from '.';
-
-/******************************************************************************
-                                 Setup
-******************************************************************************/
-
-const EnvVars = jetEnv({
-  NodeEnv: isValueOf(NodeEnvs),
-  Port: num,
-});
-
-/******************************************************************************
-                            Export default
-******************************************************************************/
-
-export default EnvVars;
+import jetEnv, { num } from 'jet-env';
+import { isValueOf } from 'jet-validators';
+
+/******************************************************************************
+                                 Constants
+******************************************************************************/
+
+// NOTE: These need to match the names of your ".env" files
+export const NodeEnvs = {
+  DEV: 'development',
+  TEST: 'test',
+  PRODUCTION: 'production',
+} as const;
+
+/******************************************************************************
+                                 Setup
+******************************************************************************/
+
+const EnvVars = jetEnv({
+  NodeEnv: isValueOf(NodeEnvs),
+  Port: num,
+});
+
+/******************************************************************************
+                            Export default
+******************************************************************************/
+
+export default EnvVars;

package/lib/project-files/src/common/utils/{misc.ts → number-utils.ts}

@@ -1,11 +1,10 @@
-
-/******************************************************************************
-                                Functions
-******************************************************************************/
-
-/**
- * Get a random number between 1 and 1,000,000,000,000
- */
-export function getRandomInt(): number {
-  return Math.floor(Math.random() * 1_000_000_000_000);
-}
+/******************************************************************************
+                                Functions
+******************************************************************************/
+
+/**
+ * Get a random number between 1 and 1,000,000,000,000
+ */
+export function getRandomInt(): number {
+  return Math.floor(Math.random() * 1_000_000_000_000);
+}

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

@@ -1,36 +1,35 @@
-import { ParseError } from 'jet-validators/utils';
-
-import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
-
-/******************************************************************************
-                                 Classes
-******************************************************************************/
-
-/**
- * Error with status code and message.
- */
-export class RouteError extends Error {
-  public status: HttpStatusCodes;
-
-  public constructor(status: HttpStatusCodes, message: string) {
-    super(message);
-    this.status = status;
-  }
-}
-
-/**
- * Handle "parseObj" errors.
- */
-export class ValidationError extends RouteError {
-
-  public static MESSAGE = 'The parseObj() function discovered one or ' + 
-    'more errors.';
-
-  public constructor(errors: ParseError[]) {
-    const msg = JSON.stringify({
-      message: ValidationError.MESSAGE,
-      errors,
-    });
-    super(HttpStatusCodes.BAD_REQUEST, msg);
-  }
-}
+import { ParseError } from 'jet-validators/utils';
+
+import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
+
+/******************************************************************************
+                                 Classes
+******************************************************************************/
+
+/**
+ * Error with status code and message.
+ */
+export class RouteError extends Error {
+  public status: HttpStatusCodes;
+
+  public constructor(status: HttpStatusCodes, message: string) {
+    super(message);
+    this.status = status;
+  }
+}
+
+/**
+ * Handle "parseObj" errors.
+ */
+export class ValidationError extends RouteError {
+  public static MESSAGE =
+    'The parseObj() function discovered one or ' + 'more errors.';
+
+  public constructor(errors: ParseError[]) {
+    const msg = JSON.stringify({
+      message: ValidationError.MESSAGE,
+      errors,
+    });
+    super(HttpStatusCodes.BAD_REQUEST, msg);
+  }
+}

package/lib/project-files/src/common/utils/validators.ts

@@ -1,14 +1,14 @@
-import { isDate } from 'jet-validators';
-import { transform } from 'jet-validators/utils';
-
-/******************************************************************************
-                                Functions
-******************************************************************************/
-
-/**
- * Convert to date object then check is a validate date.
- */
-export const transformIsDate = transform(
-  arg => new Date(arg as string),
-  arg => isDate(arg),
-);
+import { isDate } from 'jet-validators';
+import { transform } from 'jet-validators/utils';
+
+/******************************************************************************
+                                Functions
+******************************************************************************/
+
+/**
+ * Convert to date object then check is a validate date.
+ */
+export const transformIsDate = transform(
+  (arg) => new Date(arg as string),
+  (arg) => isDate(arg),
+);

package/lib/project-files/src/{index.ts → main.ts}

@@ -1,27 +1,24 @@
-import logger from 'jet-logger';
-
-import EnvVars from '@src/common/constants/EnvVars';
-import server from './server';
-
-
-/******************************************************************************
-                                Constants
-******************************************************************************/
-
-const SERVER_START_MSG = (
-  'Express server started on port: ' + EnvVars.Port.toString()
-);
-
-
-/******************************************************************************
-                                  Run
-******************************************************************************/
-
-// Start the server
-server.listen(EnvVars.Port, err => {
-  if (!!err) {
-    logger.err(err.message);
-  } else {
-    logger.info(SERVER_START_MSG);
-  }
-});
+import logger from 'jet-logger';
+
+import EnvVars from './common/constants/env';
+import server from './server';
+
+/******************************************************************************
+                                Constants
+******************************************************************************/
+
+const SERVER_START_MSG =
+  'Express server started on port: ' + EnvVars.Port.toString();
+
+/******************************************************************************
+                                  Run
+******************************************************************************/
+
+// Start the server
+server.listen(EnvVars.Port, (err) => {
+  if (!!err) {
+    logger.err(err.message);
+  } else {
+    logger.info(SERVER_START_MSG);
+  }
+});

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

@@ -1,72 +1,73 @@
-import { isNonEmptyString, isString, isUnsignedInteger } from 'jet-validators';
-import {
-  parseObject,
-  Schema,
-  testObject,
-} from 'jet-validators/utils';
-
-import { transformIsDate } from '@src/common/utils/validators';
-import { IModel } from './common/types';
-
-/******************************************************************************
-                                 Constants
-******************************************************************************/
-
-const GetDefaults = (): IUser => ({
-  id: 0,
-  name: '',
-  email: '',
-  created: new Date(),
-});
-
-/******************************************************************************
-                                  Types
-******************************************************************************/
-
-export interface IUser extends IModel {
-  name: string;
-  email: string;
-}
-
-/******************************************************************************
-                                  Setup
-******************************************************************************/
-
-const schema: Schema<IUser> = {
-  id: isUnsignedInteger,
-  name: isString,
-  email: isString,
-  created: transformIsDate,
-};
-
-// Set the "parseUser" function
-const parseUser = parseObject<IUser>(schema);
-
-// For the APIs make sure the right fields are complete
-const testIsCompleteUser = testObject<IUser>({
-  ...schema,
-  name: isNonEmptyString,
-  email: isNonEmptyString,
-});
-
-/******************************************************************************
-                                 Functions
-******************************************************************************/
-
-/**
- * New user object.
- */
-function __new__(user?: Partial<IUser>): IUser {
-  return parseUser({ ...GetDefaults(), ...user }, errors => {
-    throw new Error('Setup new user failed ' + JSON.stringify(errors, null, 2));
-  });
-}
-
-/******************************************************************************
-                                Export default
-******************************************************************************/
-
-export default {
-  new: __new__,
-  isComplete: testIsCompleteUser,
-} as const;
+import { isNonEmptyString, isString, isUnsignedInteger } from 'jet-validators';
+import { parseObject, Schema, testObject } from 'jet-validators/utils';
+
+import { transformIsDate } from '@src/common/utils/validators';
+
+import { IModel } from './common/IModel';
+
+/******************************************************************************
+                                 Constants
+******************************************************************************/
+
+const GetDefaults = (): IUser => ({
+  id: 0,
+  name: '',
+  email: '',
+  created: new Date(),
+});
+
+const schema: Schema<IUser> = {
+  id: isUnsignedInteger,
+  name: isString,
+  email: isString,
+  created: transformIsDate,
+};
+
+/******************************************************************************
+                                  Types
+******************************************************************************/
+
+/**
+ * @entity users
+ */
+export interface IUser extends IModel {
+  name: string;
+  email: string;
+}
+
+/******************************************************************************
+                                  Setup
+******************************************************************************/
+
+
+// Set the "parseUser" function
+const parseUser = parseObject<IUser>(schema);
+
+// For the APIs make sure the right fields are complete
+const testIsCompleteUser = testObject<IUser>({
+  ...schema,
+  name: isNonEmptyString,
+  email: isNonEmptyString,
+});
+
+/******************************************************************************
+                                 Functions
+******************************************************************************/
+
+/**
+ * New user object.
+ */
+function __new__(user?: Partial<IUser>): IUser {
+  return parseUser({ ...GetDefaults(), ...user }, (errors) => {
+    throw new Error('Setup new user failed ' + JSON.stringify(errors, null, 2));
+  });
+}
+
+/******************************************************************************
+                                Export default
+******************************************************************************/
+
+export default {
+  new: __new__,
+  isComplete: testIsCompleteUser,
+} as const;

package/lib/project-files/src/models/common/IModel.ts

@@ -0,0 +1,4 @@
+export interface IModel {
+  id: number; // @PK
+  created: Date | string; // @audit
+}

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

@@ -1,48 +1,50 @@
-body {
-  padding: 100px;
-  font: 14px "Lucida Grande", Helvetica, Arial, sans-serif;
-}
-
-body .users-column {
-  display: inline-block;
-  margin-right: 2em;
-  vertical-align: top;
-}
-
-body .users-column .column-header {
-  padding-bottom: 5px;
-  font-weight: 700;
-  font-size: 1.2em;
-}
-
-
-/** Add User Column **/
-
-body .add-user-col input {
-  margin-bottom: 10px;
-}
-
-body .add-user-col #add-user-btn {
-  margin-top: 2px;
-  margin-bottom: 10px;
-}
-
-
-/** Users Display Column **/
-
-.email-edit {
-  padding-bottom: 8px;
-}
-
-body .users-column .user-display-ele {
-  padding-bottom: 10px;
-}
-
-body .users-column .user-display-ele button {
-  margin-top: 2px;
-  margin-bottom: 10px;
-}
-
-body .users-column .user-display-ele .edit-view {
-  display: none;
-}
+body {
+  padding: 100px;
+  font:
+    14px 'Lucida Grande',
+    Helvetica,
+    Arial,
+    sans-serif;
+}
+
+body .users-column {
+  display: inline-block;
+  margin-right: 2em;
+  vertical-align: top;
+}
+
+body .users-column .column-header {
+  padding-bottom: 5px;
+  font-weight: 700;
+  font-size: 1.2em;
+}
+
+/** Add User Column **/
+
+body .add-user-col input {
+  margin-bottom: 10px;
+}
+
+body .add-user-col #add-user-btn {
+  margin-top: 2px;
+  margin-bottom: 10px;
+}
+
+/** Users Display Column **/
+
+.email-edit {
+  padding-bottom: 8px;
+}
+
+body .users-column .user-display-ele {
+  padding-bottom: 10px;
+}
+
+body .users-column .user-display-ele button {
+  margin-top: 2px;
+  margin-bottom: 10px;
+}
+
+body .users-column .user-display-ele .edit-view {
+  display: none;
+}

package/lib/project-files/src/repos/MockOrm.ts

@@ -1,63 +1,57 @@
-import jsonfile from 'jsonfile';
-
-import EnvVars from '@src/common/constants/EnvVars';
-import { NodeEnvs } from '@src/common/constants';
-import { IUser } from '@src/models/User';
-
-
-/******************************************************************************
-                                Constants
-******************************************************************************/
-
-const DB_FILE_NAME = (
-  EnvVars.NodeEnv === NodeEnvs.TEST 
-    ? 'database.test.json' 
-    : 'database.json'
-);
-
-
-/******************************************************************************
-                                Types
-******************************************************************************/
-
-interface IDatabase {
-  users: IUser[];
-}
-
-
-/******************************************************************************
-                                Functions
-******************************************************************************/
-
-/**
- * Fetch the json from the file.
- */
-function openDb(): Promise<IDatabase> {
-  return jsonfile.readFile(__dirname + '/' + DB_FILE_NAME) as 
-    Promise<IDatabase>;
-}
-
-/**
- * Update the file.
- */
-function saveDb(db: IDatabase): Promise<void> {
-  return jsonfile.writeFile((__dirname + '/' + DB_FILE_NAME), db);
-}
-
-/**
- * Empty the database
- */
-function cleanDb(): Promise<void> {
-  return jsonfile.writeFile((__dirname + '/' + DB_FILE_NAME), {});
-}
-
-
-/******************************************************************************
-                                Export default
-******************************************************************************/
-
-export default {
-  openDb,
-  saveDb,
-  cleanDb,
-} as const;
+import jsonfile from 'jsonfile';
+
+import EnvVars, { NodeEnvs } from '@src/common/constants/env';
+import { IUser } from '@src/models/User';
+
+/******************************************************************************
+                                Constants
+******************************************************************************/
+
+const DATABASE_FILE_PATH = __dirname + '/common' + (
+  EnvVars.NodeEnv === NodeEnvs.TEST 
+  ? '/database.test.json' 
+  : '/database.json'
+);
+
+/******************************************************************************
+                                Types
+******************************************************************************/
+
+interface IDatabase {
+  users: IUser[];
+}
+
+/******************************************************************************
+                                Functions
+******************************************************************************/
+
+/**
+ * Fetch the json from the file.
+ */
+function openDb(): Promise<IDatabase> {
+  return jsonfile.readFile(DATABASE_FILE_PATH) as Promise<IDatabase>;
+}
+
+/**
+ * Update the file.
+ */
+function saveDb(db: IDatabase): Promise<void> {
+  return jsonfile.writeFile(DATABASE_FILE_PATH, db);
+}
+
+/**
+ * Empty the database
+ */
+function cleanDb(): Promise<void> {
+  return jsonfile.writeFile( DATABASE_FILE_PATH, {});
+}
+
+/******************************************************************************
+                                Export default
+******************************************************************************/
+
+export default {
+  openDb,
+  saveDb,
+  cleanDb,
+} as const;