#2766 - setOrganizationFeaturedProjects Endpoint

src/backend/src/controllers/organizations.controller.ts

@@ -51,4 +51,15 @@ export default class OrganizationsController {
       next(error);
     }
   }
+
+  static async setOrganizationFeaturedProjects(req: Request, res: Response, next: NextFunction) {
+    try {
+      const { projectIds } = req.body;
+      const featuredProjects = await OrganizationsService.setFeaturedProjects(projectIds, req.organization, req.currentUser);
+
+      res.status(200).json(featuredProjects);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
 }

src/backend/src/routes/organizations.routes.ts

@@ -1,7 +1,8 @@
 import express from 'express';
-import { linkValidators, validateInputs } from '../utils/validation.utils';
+import { linkValidators, nonEmptyString, validateInputs } from '../utils/validation.utils';
 import OrganizationsController from '../controllers/organizations.controller';
 import multer, { memoryStorage } from 'multer';
+import { body } from 'express-validator';
 
 const organizationRouter = express.Router();
 const upload = multer({ limits: { fileSize: 30000000 }, storage: memoryStorage() });
@@ -18,4 +19,11 @@ organizationRouter.post(
 );
 
 organizationRouter.get('/images', OrganizationsController.getOrganizationImages);
+organizationRouter.post(
+  '/featured-projects/set',
+  body('projectIds').isArray(),
+  nonEmptyString(body('projectIds.*')),
+  validateInputs,
+  OrganizationsController.setOrganizationFeaturedProjects
+);
 export default organizationRouter;

src/backend/src/services/organizations.services.ts

@@ -7,6 +7,7 @@ import { createUsefulLinks } from '../utils/organizations.utils';
 import { linkTransformer } from '../transformers/links.transformer';
 import { getLinkQueryArgs } from '../prisma-query-args/links.query-args';
 import { uploadFile } from '../utils/google-integration.utils';
+import { getProjects } from '../utils/projects.utils';
 
 export default class OrganizationsService {
   /**
@@ -131,4 +132,24 @@ export default class OrganizationsService {
       exploreAsGuestImage: organization.exploreAsGuestImageId
     };
   }
+
+  static async setFeaturedProjects(projectIds: string[], organization: Organization, submitter: User) {
+    if (!(await userHasPermission(submitter.userId, organization.organizationId, isAdmin)))
+      throw new AccessDeniedAdminOnlyException('update featured projects');
+
+    //throws if all projects are not found
+    const featuredProjects = await getProjects(projectIds, organization.organizationId);
+
+    const updatedOrg = await prisma.organization.update({
+      where: { organizationId: organization.organizationId },
+      data: {
+        featuredProjects: {
+          set: featuredProjects.map((project) => ({ projectId: project.projectId }))
+        }
+      },
+      include: { featuredProjects: true }
+    });
+
+    return updatedOrg;
+  }
 }

src/backend/src/utils/projects.utils.ts

@@ -1,14 +1,18 @@
-import { WBS_Element_Status } from '@prisma/client';
+import { Project, WBS_Element_Status } from '@prisma/client';
 import prisma from '../prisma/prisma';
 import { DescriptionBulletPreview, LinkCreateArgs, WbsElementStatus } from 'shared';
-import { DeletedException, NotFoundException } from './errors.utils';
+import { DeletedException, HttpException, NotFoundException } from './errors.utils';
 import { ChangeCreateArgs, createChange, createListChanges, getDescriptionBulletChanges } from './changes.utils';
 import { DescriptionBulletDestination, addRawDescriptionBullets, editDescriptionBullets } from './description-bullets.utils';
 import { linkToChangeListValue, updateLinks } from './links.utils';
 import { getLinkQueryArgs } from '../prisma-query-args/links.query-args';
 import { getDescriptionBulletQueryArgs } from '../prisma-query-args/description-bullets.query-args';
 import { getProjectQueryArgs } from '../prisma-query-args/projects.query-args';
 
+export type ProjectWithId = {
+  projectId: String;
+};
+
 /**
  * calculate the project's status based on its workpacakges' status
  * @param proj a given project to be calculated on its status
@@ -213,3 +217,32 @@ export const checkMaterialInputs = async (
     if (!unit) throw new NotFoundException('Unit', unitName);
   }
 };
+
+/**
+ * Produce a array of primsa formated projectIDs, given the array of Project
+ * @param projectIds the projectIds to get as users
+ * @returns projectIds in prisma format
+ */
+export const getProjects = async (projectIds: string[], organizationId: string) => {
+  const projects = await prisma.project.findMany({
+    where: { projectId: { in: projectIds } },
+    ...getProjectQueryArgs(organizationId)
+  });
+
+  validateFoundProjects(projects, projectIds);
+
+  return projects;
+};
+
+/**
+ * Validates that the projects found in the database match the given projectIds
+ * @param projects the projects found in the database
+ * @param projectIds the requested projectIds to retrieve
+ */
+const validateFoundProjects = (projects: Project[], projectIds: string[]) => {
+  if (projects.length !== projectIds.length) {
+    const primsaProjectIds = projects.map((project) => project.projectId);
+    const missingProjectIds = projectIds.filter((id) => !primsaProjectIds.includes(id));
+    throw new HttpException(404, `Projects(s) with the following ids not found: ${missingProjectIds.join(', ')}`);
+  }
+};