express-generator-typescript 2.8.0 → 2.9.0

package/lib/{project-files → template}/src/common/constants/HttpStatusCodes.ts

@@ -1,9 +1,8 @@
+import { ValueOf } from '../types/utility-types';
 
-/******************************************************************************
-                                Constants
-******************************************************************************/
-
-import { ValueOf } from "../types/structure-utils";
+// ========================================================================= //
+//                                 CONSTANTS                                 //
+// ========================================================================= //
 
 /**
  * Hypertext Transfer Protocol (HTTP) response status codes.
@@ -386,9 +385,9 @@ const HttpStatusCodes = {
   NETWORK_AUTHENTICATION_REQUIRED: 511,
 } as const;
 
-/******************************************************************************
-                            Export default
-******************************************************************************/
+// ========================================================================= //
+//                                  EXPORT                                   //
+// ========================================================================= //
 
 type HttpStatusCodes = ValueOf<typeof HttpStatusCodes>;
 export default HttpStatusCodes;

package/lib/template/src/common/constants/Paths.ts

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

package/lib/template/src/common/constants/env.ts

@@ -0,0 +1,28 @@
+import jetEnv, { num } from 'jet-env';
+import tspo from 'tspo';
+
+// ========================================================================= //
+//                                 CONSTANTS                                 //
+// ========================================================================= //
+
+// NOTE: These need to match the names of your ".env" files
+export const NodeEnvs = {
+  DEV: 'development',
+  TEST: 'test',
+  PRODUCTION: 'production',
+} as const;
+
+// ========================================================================= //
+//                                   EXEC                                    //
+// ========================================================================= //
+
+const EnvVars = jetEnv({
+  NodeEnv: (v) => tspo.isValue(NodeEnvs, v),
+  Port: num,
+});
+
+// ========================================================================= //
+//                                  EXPORT                                   //
+// ========================================================================= //
+
+export default EnvVars;

package/lib/template/src/common/types/utility-types.ts

@@ -0,0 +1,5 @@
+// ========================================================================= //
+//                                   TYPES                                   //
+// ========================================================================= //
+
+export type ValueOf<T> = T[keyof T];

package/lib/template/src/common/utils/date-utils.ts

@@ -0,0 +1,29 @@
+// ========================================================================= //
+//                                   TYPES                                   //
+// ========================================================================= //
+
+export type ISOString =
+  `${number}-${number}-${number}T${number}:${number}:${number}${string}`;
+
+// ========================================================================= //
+//                                 FUNCTIONS                                 //
+// ========================================================================= //
+
+/**
+ * Return the current-date (or a provided date) as an ISOString.
+ */
+export function getISOString(date = new Date()): ISOString {
+  return date.toISOString() as ISOString;
+}
+
+/**
+ * Validate an ISOString.
+ */
+export function isISOString(value: unknown): value is ISOString {
+  try {
+    const date = new Date(value as string);
+    return !isNaN(date.getTime()) && date.toISOString() === value;
+  } catch {
+    return false;
+  }
+}

package/lib/template/src/common/utils/route-errors.ts

@@ -0,0 +1,37 @@
+import { ParseError } from 'jet-validators/utils';
+
+import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
+
+// ========================================================================= //
+//                                  CLASSES                                  //
+// ========================================================================= //
+
+/**
+ * Error with status code and message. `errors` (optional) is sent to the
+ * client alongside the message.
+ */
+export class RouteError extends Error {
+  public status: HttpStatusCodes;
+  public errors?: unknown[];
+
+  public constructor(
+    status: HttpStatusCodes,
+    message: string,
+    errors?: unknown[],
+  ) {
+    super(message);
+    this.status = status;
+    this.errors = errors;
+  }
+}
+
+/**
+ * Request data failed schema validation.
+ */
+export class ValidationError extends RouteError {
+  public static MESSAGE = 'Request validation failed.';
+
+  public constructor(errors: ParseError[]) {
+    super(HttpStatusCodes.BAD_REQUEST, ValidationError.MESSAGE, errors);
+  }
+}

package/lib/template/src/main.ts

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

package/lib/template/src/models/User.model.ts

@@ -0,0 +1,95 @@
+import jetid from 'jet-id';
+import { isNonEmptyString, isString } from 'jet-validators';
+import { parseObject, Schema, testObject } from 'jet-validators/utils';
+
+import { getISOString, isISOString } from '@src/common/utils/date-utils';
+
+import { Entity } from './common/types';
+
+// ========================================================================= //
+//                                 CONSTANTS                                 //
+// ========================================================================= //
+
+const GetDefaults = (): IUser => ({
+  id: jetid(),
+  name: '',
+  email: '',
+  created: getISOString(),
+});
+
+const schema: Schema<IUser> = {
+  id: isUserId,
+  name: isString,
+  email: isString,
+  created: isISOString,
+};
+
+// ========================================================================= //
+//                                   TYPES                                   //
+// ========================================================================= //
+
+/**
+ * @entity users
+ */
+export interface IUser extends Entity {
+  name: string;
+  email: string;
+}
+
+/**
+ * Fields a client supplies when creating a user; the server sets the rest.
+ */
+export type IUserInput = Pick<IUser, 'name' | 'email'>;
+
+// ========================================================================= //
+//                                 FUNCTIONS                                 //
+// ========================================================================= //
+
+/**
+ * Validate the `User` schema.
+ */
+const parseUser = parseObject<IUser>(schema);
+
+/**
+ * For the APIs make sure the right fields are complete
+ */
+const isCompleteUser = testObject<IUser>({
+  ...schema,
+  name: isNonEmptyString,
+  email: isNonEmptyString,
+});
+
+/**
+ * Validate the fields a client sends to create a user.
+ */
+const isUserInput = testObject<IUserInput>({
+  name: isNonEmptyString,
+  email: isNonEmptyString,
+});
+
+/**
+ * Test if an id is a valid user id.
+ */
+function isUserId(val: unknown): val is string {
+  return jetid.test(val);
+}
+
+/**
+ * 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                                   //
+// ========================================================================= //
+
+export default {
+  new: new_,
+  isId: isUserId,
+  isComplete: isCompleteUser,
+  isInput: isUserInput,
+} as const;

package/lib/template/src/models/common/types.ts

@@ -0,0 +1,10 @@
+import { ISOString } from "@src/common/utils/date-utils";
+
+// ========================================================================= //
+//                                   TYPES                                   //
+// ========================================================================= //
+
+export interface Entity {
+  id: string; // @PK
+  created: ISOString; // @audit
+}

package/lib/template/src/public/scripts/http.js

@@ -0,0 +1,25 @@
+var Http = (() => {
+  // Setup request for json
+  var getOptions = (verb, data) => {
+    var options = {
+      dataType: 'json',
+      method: verb,
+      headers: {
+        Accept: 'application/json',
+        'Content-Type': 'application/json',
+      },
+    };
+    if (!!data) {
+      options.body = JSON.stringify(data);
+    }
+    return options;
+  };
+
+  // Set Http methods
+  return {
+    get: (path) => fetch(path, getOptions('GET')),
+    post: (path, data) => fetch(path, getOptions('POST', data)),
+    put: (path, data) => fetch(path, getOptions('PUT', data)),
+    delete: (path) => fetch(path, getOptions('DELETE')),
+  };
+})();