#3169 getparttags endpoint

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

@@ -179,4 +179,13 @@ export default class OrganizationsController {
       next(error);
     }
   }
+
+  static async getAllPartTags(req: Request, res: Response, next: NextFunction) {
+    try {
+      const tags = await OrganizationsService.getAllPartTags(req.organization.organizationId);
+      res.status(200).json(tags);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
 }

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

@@ -62,4 +62,5 @@ organizationRouter.post(
   nonEmptyString(body('workspaceId')),
   OrganizationsController.setSlackWorkspaceId
 );
+organizationRouter.get('/getAllPartTags', OrganizationsController.getAllPartTags);
 export default organizationRouter;

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

@@ -407,4 +407,31 @@ export default class OrganizationsService {
 
     return updatedOrg;
   }
+
+  /**
+   * Uses the given organizationID to and returns an array of part tags
+   * @param organizationId the organization to get the parts for
+   * @returns an array of part tags
+   */
+  static async getAllPartTags(organizationId: string) {
+    const organization = await prisma.organization.findUnique({
+      where: { organizationId }
+    });
+
+    if (!organization) {
+      throw new NotFoundException('Organization', organizationId);
+    }
+
+    return prisma.partTag.findMany({
+      where: { organizationId },
+      select: {
+        partTagId: true,
+        parts: {
+          select: {
+            partId: true
+          }
+        }
+      }
+    });
+  }
 }

src/backend/tests/unmocked/part-review.test.ts

@@ -0,0 +1,52 @@
+import { NotFoundException } from '../../src/utils/errors.utils';
+import OrganizationsService from '../../src/services/organizations.services';
+import { createTestOrganization, resetUsers } from '../test-utils';
+import prisma from '../../src/prisma/prisma';
+import { Organization } from '@prisma/client';
+
+describe('Get All Part Tags', () => {
+  let organizationID: string;
+  let organization: Organization;
+
+  beforeEach(async () => {
+    organization = await createTestOrganization();
+    organizationID = organization.organizationId;
+    await prisma.partTag.deleteMany();
+  });
+
+  afterEach(async () => {
+    await resetUsers();
+  });
+
+  it('Fails if organization does not exist', async () => {
+    await expect(OrganizationsService.getAllPartTags('no-id')).rejects.toThrow(
+      new NotFoundException('Organization', 'no-id')
+    );
+  });
+
+  it('Succeeds and returns empty array', async () => {
+    const partTags = await OrganizationsService.getAllPartTags(organizationID);
+    expect(partTags).toBeInstanceOf(Array);
+    expect(partTags.length).toEqual(0);
+  });
+
+  it('Succeeds and returns part tags', async () => {
+    await prisma.partTag.createMany({
+      data: [
+        {
+          partTagId: '123',
+          name: 'Screw',
+          colorHexCode: '#191010',
+          dateCreated: new Date(),
+          organizationId: organizationID
+        },
+        { partTagId: '456', name: 'Bolt', colorHexCode: '#093121', dateCreated: new Date(), organizationId: organizationID }
+      ]
+    });
+
+    const partTags = await OrganizationsService.getAllPartTags(organizationID);
+    expect(partTags.length).toEqual(2);
+    expect(partTags.some((tag) => tag.partTagId === '123')).toBeTruthy();
+    expect(partTags.some((tag) => tag.partTagId === '456')).toBeTruthy();
+  });
+});

src/shared/src/types/parts-review.types.ts

@@ -0,0 +1,12 @@
+import { Organization } from './user-types';
+
+export interface PartTagReviewType {
+  partTagId: string;
+  name: string;
+  colorHexCode: string;
+  dateCreated: Date;
+  dateDeleted?: Date;
+  parts: String[];
+  organization?: Organization;
+  organizationId: string;
+}