Merge pull request #1651 from Northeastern-Electric-Racing/#1525-create-materials

#1525 Create Materials Endpoint

Author: RChandler234

src/backend/src/controllers/projects.controllers.ts

@@ -140,6 +140,48 @@ export default class ProjectsController {
     }
   }
 
+  static async createMaterial(req: Request, res: Response, next: NextFunction) {
+    try {
+      const {
+        name,
+        assemblyId,
+        status,
+        materialTypeName,
+        manufacturerName,
+        manufacturerPartNumber,
+        pdmFileName,
+        quantity,
+        unitName,
+        price,
+        subtotal,
+        linkUrl,
+        notes
+      } = req.body;
+      const creator = await getCurrentUser(res);
+      const wbsNum = validateWBS(req.params.wbsNum);
+      const material = await ProjectsService.createMaterial(
+        creator,
+        name,
+        status,
+        materialTypeName,
+        manufacturerName,
+        manufacturerPartNumber,
+        quantity,
+        unitName,
+        price,
+        subtotal,
+        linkUrl,
+        notes,
+        wbsNum,
+        assemblyId,
+        pdmFileName
+      );
+      return res.status(200).json(material);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
+
   static async createManufacturer(req: Request, res: Response, next: NextFunction) {
     try {
       const { name } = req.body;

src/backend/src/routes/projects.routes.ts

@@ -1,6 +1,6 @@
 import express from 'express';
 import { body } from 'express-validator';
-import { intMinZero, nonEmptyString } from '../utils/validation.utils';
+import { intMinZero, isMaterialStatus, nonEmptyString } from '../utils/validation.utils';
 import { validateInputs } from '../utils/utils';
 import ProjectsController from '../controllers/projects.controllers';
 
@@ -62,5 +62,23 @@ projectRouter.post(
   nonEmptyString(body('pdmFileName')).optional(),
   ProjectsController.createAssembly
 );
+projectRouter.post(
+  '/material/:wbsNum/create',
+  nonEmptyString(body('name')),
+  nonEmptyString(body('assemblyId').optional()),
+  isMaterialStatus(body('status')),
+  nonEmptyString(body('materialTypeName')),
+  nonEmptyString(body('manufacturerName')),
+  nonEmptyString(body('manufacturerPartNumber')),
+  nonEmptyString(body('pdmFileName').optional()),
+  intMinZero(body('quantity')),
+  nonEmptyString(body('unitName')),
+  intMinZero(body('price')), // in cents
+  intMinZero(body('subtotal')), // in cents
+  nonEmptyString(body('linkUrl').isURL()),
+  body('notes').isString(),
+  validateInputs,
+  ProjectsController.createMaterial
+);
 
 export default projectRouter;

src/backend/src/services/projects.services.ts

@@ -1,4 +1,4 @@
-import { Material_Type, User, Assembly } from '@prisma/client';
+import { Material_Type, User, Assembly, Material_Status, Material } from '@prisma/client';
 import { isAdmin, isGuest, isLeadership, isProject, LinkCreateArgs, LinkType, Project, WbsNumber, wbsPipe } from 'shared';
 import projectQueryArgs from '../prisma-query-args/projects.query-args';
 import prisma from '../prisma/prisma';
@@ -605,6 +605,103 @@ export default class ProjectsService {
     ).map(linkTypeTransformer);
   }
 
+  /**
+   * Creates a new Material
+   * @param creator the user creating the material
+   * @param name the name of the material
+   * @param status the Material Status of the material
+   * @param materialTypeName the name of the Material Type
+   * @param manufacturerName the name of the material's manufacturer
+   * @param manufacturerPartNumber the manufacturer part number for the material
+   * @param quantity the quantity of material as a number
+   * @param unitName the name of the Quantity Unit the quantity is measured in
+   * @param price the price of the material in whole cents
+   * @param subtotal the subtotal of the price for the material in whole cents
+   * @param linkUrl the url for the material's link as a string
+   * @param notes any notes about the material as a string
+   * @param wbsNumber the WBS number of the project associated with this material
+   * @param assemblyId the id of the Assembly for the material
+   * @param pdmFileName the name of the pdm file for the material
+   * @returns the created material
+   */
+  static async createMaterial(
+    creator: User,
+    name: string,
+    status: Material_Status,
+    materialTypeName: string,
+    manufacturerName: string,
+    manufacturerPartNumber: string,
+    quantity: number,
+    unitName: string,
+    price: number,
+    subtotal: number,
+    linkUrl: string,
+    notes: string,
+    wbsNumber: WbsNumber,
+    assemblyId?: string,
+    pdmFileName?: string
+  ): Promise<Material> {
+    const project = await prisma.project.findFirst({
+      where: {
+        wbsElement: {
+          carNumber: wbsNumber.carNumber,
+          projectNumber: wbsNumber.projectNumber,
+          workPackageNumber: wbsNumber.workPackageNumber
+        }
+      },
+      ...projectQueryArgs
+    });
+
+    if (!project) throw new NotFoundException('Project', wbsPipe(wbsNumber));
+
+    if (assemblyId) {
+      const assembly = await prisma.assembly.findFirst({ where: { assemblyId } });
+      if (!assembly) throw new NotFoundException('Assembly', assemblyId);
+    }
+
+    const materialType = await prisma.material_Type.findFirst({
+      where: { name: materialTypeName }
+    });
+    if (!materialType) throw new NotFoundException('Material Type', materialTypeName);
+
+    const manufacturer = await prisma.manufacturer.findFirst({
+      where: { name: manufacturerName }
+    });
+    if (!manufacturer) throw new NotFoundException('Manufacturer', manufacturerName);
+
+    const unit = await prisma.unit.findFirst({
+      where: { name: unitName }
+    });
+    if (!unit) throw new NotFoundException('Unit', unitName);
+
+    const perms = isLeadership(creator.role) || isUserPartOfTeams(project.teams, creator);
+
+    if (!perms) throw new AccessDeniedException('create materials');
+
+    const createdMaterial = await prisma.material.create({
+      data: {
+        userCreatedId: creator.userId,
+        name,
+        assemblyId,
+        status,
+        materialTypeName,
+        manufacturerName,
+        manufacturerPartNumber,
+        pdmFileName,
+        quantity,
+        unitName,
+        price,
+        subtotal,
+        linkUrl,
+        notes,
+        dateCreated: new Date(),
+        wbsElementId: project.wbsElementId
+      }
+    });
+
+    return createdMaterial;
+  }
+
   /**
    * Create an assembly
    * @param name The name of the assembly to be created

src/backend/src/utils/errors.utils.ts

@@ -111,4 +111,8 @@ type ExceptionObjectNames =
   | 'Expense Type'
   | 'Reimbursement Request'
   | 'User Secure Settings'
-  | 'Image File';
+  | 'Image File'
+  | 'Assembly'
+  | 'Material Type'
+  | 'Manufacturer'
+  | 'Unit';

src/backend/src/utils/validation.utils.ts

@@ -1,5 +1,5 @@
 import { ValidationChain } from 'express-validator';
-import { ClubAccount } from 'shared';
+import { ClubAccount, MaterialStatus } from 'shared';
 import { TaskPriority, TaskStatus, WorkPackageStage, RoleEnum } from 'shared';
 
 export const intMinZero = (validationObject: ValidationChain): ValidationChain => {
@@ -44,3 +44,9 @@ export const isWorkPackageStageOrNone = (validationObject: ValidationChain): Val
 export const isAccount = (validationObject: ValidationChain): ValidationChain => {
   return validationObject.isString().isIn([ClubAccount.BUDGET, ClubAccount.CASH]);
 };
+
+export const isMaterialStatus = (validationObject: ValidationChain): ValidationChain => {
+  return validationObject
+    .isString()
+    .isIn([MaterialStatus.Ordered, MaterialStatus.Received, MaterialStatus.Unordered, MaterialStatus.Shipped]);
+};