feature/lisasiliu/add-programs-form-backend-route

backend/src/app.ts

@@ -7,6 +7,7 @@ import mongoose from "mongoose";
 import { mongoURI, port } from "./config";
 import { errorHandler } from "./errors/handler";
 import router from "./routes/api";
+import program from "./routes/program";
 
 /**
  * Express server application class
@@ -30,6 +31,8 @@ void mongoose
 
 // Middleware
 server.app.use(json());
+server.app.use("/program", program);
+server.app.use(errorHandler);
 
 // sets the "Access-Control-Allow-Origin" header on all responses to allow
 server.app.use(cors());

backend/src/controllers/program.ts

@@ -0,0 +1,30 @@
+/* eslint-disable @typescript-eslint/no-misused-promises */
+import { RequestHandler } from "express";
+import { validationResult } from "express-validator";
+
+import ProgramFormModel from "../models/program-form";
+import validationErrorParser from "../util/validationErrorParser";
+
+export type Program = {
+  name: string;
+  abbreviation: string;
+  type: string;
+  daysOfWeek: string[];
+  startDate: string;
+  endDate: string;
+  color: string; //colorValueHex;
+};
+
+export const createForm: RequestHandler = async (req, res, next) => {
+  const errors = validationResult(req);
+
+  try {
+    validationErrorParser(errors);
+
+    const programForm = await ProgramFormModel.create(req.body as Program);
+
+    res.status(201).json(programForm);
+  } catch (error) {
+    next(error);
+  }
+};

backend/src/errors/handler.ts

@@ -1,12 +1,12 @@
-import { Request, Response } from "express";
+import { NextFunction, Request, Response } from "express";
 
 import { CustomError } from "./errors";
 import { InternalError } from "./internal";
 
 /**
  * Generic Error Handler
  */
-export const errorHandler = (err: Error, req: Request, res: Response) => {
+export const errorHandler = (err: Error, _req: Request, res: Response, _nxt: NextFunction) => {
   if (!err) return;
   if (err instanceof CustomError && !(err instanceof InternalError)) {
     console.log(err.displayMessage(true));

backend/src/models/program-form.ts

@@ -0,0 +1,17 @@
+//modified from onboarding repo for program form backend
+
+import { InferSchemaType, Schema, model } from "mongoose";
+
+const programSchema = new Schema({
+  name: { type: String, required: true },
+  abbreviation: { type: String, required: true }, // e.g. ENTR
+  type: { type: String, required: true }, // regular vs. varying
+  daysOfWeek: { type: [String], required: true }, // M, T, W, TH, F
+  startDate: { type: Date, required: true },
+  endDate: { type: Date, required: true },
+  color: { type: String, required: true }, // options: 1 (teal, #4FA197), 2 (yellow, #FFB800), 3 (pink, #FF7A5E), 4 (olive, #B6BF0E)
+});
+
+type ProgramForm = InferSchemaType<typeof programSchema>;
+
+export default model<ProgramForm>("ProgramForm", programSchema);

backend/src/routes/program.ts

@@ -0,0 +1,14 @@
+/**
+ * Task route requests.
+ */
+
+import express from "express"; // { RequestHandler }
+
+import * as ProgramController from "../controllers/program";
+import * as ProgramValidator from "../validators/program";
+
+const router = express.Router();
+
+router.post("/", ProgramValidator.createForm, ProgramController.createForm);
+
+export default router;

backend/src/validators/program.ts

@@ -0,0 +1,114 @@
+import { body } from "express-validator";
+
+import { Program } from "../controllers/program";
+
+const makeNameValidator = () =>
+  body("name")
+    .exists()
+    .withMessage("name needed")
+    .bail()
+    .isString()
+    .withMessage("name must be a string")
+    .bail()
+    .notEmpty()
+    .withMessage("name must not be empty");
+const makeAbbreviationValidator = () =>
+  body("abbreviation")
+    .exists()
+    .withMessage("abbreviation needed")
+    .bail()
+    .isString()
+    .withMessage("abbreviation must be a string")
+    .bail()
+    .notEmpty()
+    .withMessage("abbreviation must not be empty");
+const makeTypeValidator = () =>
+  body("type")
+    .exists()
+    .withMessage("type needed")
+    .bail()
+    .isString()
+    .withMessage("type must be a string")
+    .bail()
+    .notEmpty()
+    .withMessage("type must not be empty")
+    .custom((value: string) => {
+      if (value !== "regular" && value !== "varying")
+        throw new Error("program type must be regular or varying");
+      return true;
+    });
+const makeDaysOfWeekValidator = () =>
+  body("daysOfWeek")
+    .exists()
+    .withMessage("days of week selection needed")
+    .bail()
+    .isArray()
+    .withMessage("days of week selection must be an array")
+    .custom((value: string[]) => {
+      if (value.length === 0) throw new Error("days of week selection needed");
+      for (const valuei of value) {
+        if (valuei !== "M" && valuei !== "T" && valuei !== "W" && valuei !== "TH" && valuei !== "F")
+          throw new Error("days of week selection must be M, T, W, TH, or F");
+      }
+      return true;
+    });
+const makeStartDateValidator = () =>
+  body("startDate")
+    .exists()
+    .withMessage("start date needed")
+    .bail()
+    .isISO8601()
+    .withMessage("start date must be a valid date-time string");
+const makeEndDateValidator = () =>
+  body("endDate")
+    .exists()
+    .withMessage("end date needed")
+    .bail()
+    .isISO8601()
+    .withMessage("end date must be a valid date-time string")
+    .bail()
+    .custom((value: string, { req }) => {
+      const reqBody: Program = req.body as Program;
+      if (new Date(value) < new Date(reqBody.startDate))
+        throw new Error("end date must be after start date");
+      return true;
+    });
+const makeColorValidator = () =>
+  body("color")
+    .exists()
+    .withMessage("color needed")
+    .bail()
+    .isString()
+    .withMessage("color hex should be string")
+    .isLength({ min: 7, max: 7 })
+    .withMessage("color hex should have 7 characters")
+    .bail()
+    .notEmpty()
+    .withMessage("color hex required")
+    .bail()
+    .custom((value: string) => {
+      if (value.length !== 7) throw new Error("color hex should have 7 characters");
+      if (!value.startsWith("#")) throw new Error("color hex should start with #");
+      for (let i = 1; i <= 6; i++) {
+        const code = value.charCodeAt(i);
+        if (
+          !(code > 47 && code < 58) && // numeric (0-9)
+          !(code > 64 && code < 91)
+        ) {
+          // upper alpha (A-Z)
+          throw new Error("color hex must be a hex string, with characters 0-9 or A-F");
+        }
+      }
+      return true;
+    });
+// check for first chara being # and others being 1-F
+
+export const createForm = [
+  makeNameValidator(),
+  makeAbbreviationValidator(),
+  makeTypeValidator(),
+  makeDaysOfWeekValidator(),
+  makeStartDateValidator(),
+  makeEndDateValidator(),
+  makeColorValidator(),
+];