Merge branch 'main' into feature/arohanrachel/our-impact

Author: jennymar

.husky/lint-config.sh

@@ -6,6 +6,8 @@ import "dotenv/config";
 import cors from "cors";
 import express, { NextFunction, Request, Response } from "express";
 import { isHttpError } from "http-errors";
+import subscriberRoutes from "src/routes/subscriber";
+import memberRoutes from "src/routes/members";
 
 const app = express();
 
@@ -24,6 +26,8 @@ app.use(
 );
 
 // Routes ( e.g. app.use("/api/task", taskRoutes); )
+app.use("/api/subscribers", subscriberRoutes);
+app.use("/api/member", memberRoutes);
 
 /**
  * Error handler; all errors thrown by server are handled here.

.husky/pre-commit

@@ -0,0 +1,36 @@
+import { RequestHandler } from "express";
+import MemberModel from "src/models/member";
+import { Types } from "mongoose";
+
+export const createMember: RequestHandler = async (req, res, next) => {
+  const { name, role, profilePictureURL } = req.body;
+  try {
+    const member = await MemberModel.create({
+      name: name,
+      role: role,
+      profilePictureURL: profilePictureURL,
+    });
+    res.status(201).json(member);
+  } catch (error) {
+    next(error);
+  }
+};
+
+export const getMember: RequestHandler = async (req, res, next) => {
+  const { id } = req.params;
+  try {
+    const member = Types.ObjectId.isValid(id) ? await MemberModel.findById(id) : null;
+    res.status(200).json(member);
+  } catch (error) {
+    next(error);
+  }
+};
+
+export const getAllMembers: RequestHandler = async (req, res, next) => {
+  try {
+    const members = await MemberModel.find({});
+    res.status(200).json(members);
+  } catch (error) {
+    next(error);
+  }
+};

.husky/pre-push

@@ -0,0 +1,32 @@
+/*
+ * Controller for the newsletter subscriber route, /api/subscribers.
+ * passes error handling off to /src/util/validationErrorParser.ts
+ */
+
+import { RequestHandler } from "express";
+import { validationResult } from "express-validator";
+import Subscriber from "src/models/subscriber";
+import validationErrorParser from "src/util/validationErrorParser";
+
+export const createSubscriber: RequestHandler = async (req, res, next) => {
+  const errors = validationResult(req);
+  const { email } = req.body;
+
+  try {
+    // validationErrorParser is a helper that throws 400 if there are errors
+    validationErrorParser(errors);
+    const subscriber = await Subscriber.create({
+      email: email,
+    });
+
+    /*
+     * TODO: Handle adding the newsletter subscriber
+     * to a mailing list or however this will be handled.
+     */
+
+    // successfully created subscriber in db
+    res.status(201).json(subscriber);
+  } catch (error) {
+    next(error);
+  }
+};

backend/src/app.ts

@@ -0,0 +1,11 @@
+import { InferSchemaType, Schema, model } from "mongoose";
+
+const memberSchema = new Schema({
+  name: { type: String, required: true },
+  role: { type: String, required: true },
+  profilePictureURL: { type: String },
+});
+
+type Member = InferSchemaType<typeof memberSchema>;
+
+export default model<Member>("Member", memberSchema);

backend/src/controllers/member.ts

@@ -0,0 +1,13 @@
+/*
+ * Defines the schema for a newsletter subscriber
+ */
+
+import { InferSchemaType, Schema, model } from "mongoose";
+
+const subscriberSchema = new Schema({
+  email: { type: String, required: true },
+});
+
+type Subscriber = InferSchemaType<typeof subscriberSchema>;
+
+export default model<Subscriber>("Subscriber", subscriberSchema);

backend/src/controllers/subscriber.ts

@@ -0,0 +1,9 @@
+import express from "express";
+import * as MembersController from "src/controllers/member";
+
+const router = express.Router();
+
+router.get("/get", MembersController.getAllMembers);
+router.post("/post", MembersController.createMember);
+
+export default router;

backend/src/models/member.ts

@@ -0,0 +1,13 @@
+/*
+ * Newsletter subscription route requests.
+ */
+
+import express from "express";
+import * as SubscriberController from "src/controllers/subscriber";
+import * as SubscriberValidator from "src/validators/subscriber";
+
+const router = express.Router();
+
+router.post("/", SubscriberValidator.createSubscriber, SubscriberController.createSubscriber);
+
+export default router;