fix: scoped the response for list and search permits

- Updated types for list and search permits to include activity and activityContact

Signed-off-by: Sanjay Babu <sanjaytkbabu@gmail.com>

Author: sanjaytkbabu

app/src/routes/v1/permit.ts

@@ -10,6 +10,7 @@ import {
 import { hasAccess, hasAuthorization } from '../../middleware/authorization.ts';
 import { requireSomeAuth } from '../../middleware/requireSomeAuth.ts';
 import { requireSomeGroup } from '../../middleware/requireSomeGroup.ts';
+import { filterActivityResponseByScope } from '../../middleware/responseFiltering.ts';
 import { Action, Resource } from '../../utils/enums/application.ts';
 import { permitValidator } from '../../validators/index.ts';
 
@@ -18,7 +19,13 @@ router.use(requireSomeAuth);
 router.use(requireSomeGroup);
 
 /** Get a list of permits */
-router.get('/', hasAuthorization(Resource.PERMIT, Action.READ), permitValidator.listPermits, listPermitsController);
+router.get(
+  '/',
+  hasAuthorization(Resource.PERMIT, Action.READ),
+  permitValidator.listPermits,
+  filterActivityResponseByScope,
+  listPermitsController
+);
 
 /** Create or update a permit */
 router.put('/', hasAuthorization(Resource.PERMIT, Action.CREATE), permitValidator.upsertPermit, upsertPermitController);
@@ -37,6 +44,7 @@ router.get(
   '/search',
   hasAuthorization(Resource.PERMIT, Action.READ),
   permitValidator.searchPermits,
+  filterActivityResponseByScope,
   searchPermitsController
 );
 

app/src/services/permit.ts

@@ -6,6 +6,7 @@ import type {
   Permit,
   PermitBase,
   PermitSearchParams,
+  PermitWithActivityProject,
   SearchPermitsOptions
 } from '../types/index.ts';
 
@@ -65,6 +66,11 @@ export const listPermits = async (tx: PrismaTransactionClient, options?: ListPer
       }
     },
     include: {
+      activity: {
+        include: {
+          activityContact: true
+        }
+      },
       permitType: true,
       permitNote: options?.includeNotes ? { orderBy: { createdAt: 'desc' } } : false,
       permitTracking: {
@@ -148,7 +154,7 @@ export const searchPermitsPaginated = async (
   tx: PrismaTransactionClient,
   initiative: Exclude<Initiative, Initiative.PCNS>,
   options: SearchPermitsOptions
-): Promise<{ permits: Permit[]; totalRecords: number }> => {
+): Promise<{ permits: PermitWithActivityProject[]; totalRecords: number }> => {
   // Determine project table based on initiative, exclude PCNS
   const projectTableMap: Record<Exclude<Initiative, Initiative.PCNS>, string> = {
     [Initiative.ELECTRIFICATION]: 'electrificationProject',
@@ -252,6 +258,7 @@ export const searchPermitsPaginated = async (
       },
       activity: {
         include: {
+          activityContact: true,
           [projectTable]: true
         }
       }
@@ -268,7 +275,7 @@ export const searchPermitsPaginated = async (
         ...activityData,
         project: projectData
       }
-    };
+    } as unknown as PermitWithActivityProject;
   });
 
   return { permits: permitsWithProjectAlias, totalRecords };

app/src/types/models.ts

@@ -8,7 +8,11 @@ export type AccessRequestPatch = Omit<Prisma.access_requestUpdateInput, 'accessR
 
 const activityBase = Prisma.validator<Prisma.activityDefaultArgs>()({});
 export type ActivityBase = Prisma.activityGetPayload<typeof activityBase>;
-export type Activity = ActivityBase & { activityContact?: ActivityContact[]; initiative?: Initiative };
+export type Activity = ActivityBase & {
+  activityContact?: ActivityContact[];
+  initiative?: Initiative;
+  project?: ElectrificationProject | GeneralProject | HousingProject | null;
+};
 
 const activityContactBase = Prisma.validator<Prisma.activity_contactDefaultArgs>()({});
 export type ActivityContactBase = Prisma.activity_contactGetPayload<typeof activityContactBase>;
@@ -107,6 +111,7 @@ const permitBase = Prisma.validator<Prisma.permitDefaultArgs>()({});
 type PermitBasePrisma = Prisma.permitGetPayload<typeof permitBase>;
 export type PermitBase = Omit<PermitBasePrisma, PermitDateTimeKeys> & Record<PermitDateTimeKeys, string | null>;
 export type Permit = PermitBase & {
+  activity?: Activity;
   permitNote?: PermitNote[];
   permitTracking?: PermitTracking[];
   permitType?: PermitType;

app/src/types/stuff.d.ts

@@ -8,6 +8,7 @@ import { ApplicationStatus, SubmissionType } from '../utils/enums/projectCommon.
 
 import type {
   AccessRequest,
+  Activity,
   Contact,
   ElectrificationProject,
   GeneralProject,
@@ -393,6 +394,12 @@ export interface PermitUpdateEmailParams {
   emailTemplate: EmailTemplate;
 }
 
+export interface PermitWithActivityProject extends Permit {
+  activity: Activity & {
+    project: ElectrificationProject | GeneralProject | HousingProject | null;
+  };
+}
+
 export interface UpdatedPermitWithNote {
   permit: Permit;
   note: string | undefined;

app/tests/unit/controllers/permit.spec.ts

@@ -46,6 +46,7 @@ import type {
   ListPermitsOptions,
   Permit,
   PermitUpdateEmailParams,
+  PermitWithActivityProject,
   SearchPermitsOptions
 } from '../../../src/types/index.ts';
 
@@ -183,6 +184,14 @@ describe('listPermitsController', () => {
 describe('searchPermitsController', () => {
   const searchSpy = vi.spyOn(permitService, 'searchPermitsPaginated');
 
+  const TEST_PERMIT_WITH_HOUSING_PROJECT: PermitWithActivityProject = {
+    ...TEST_PERMIT_1,
+    activity: {
+      ...TEST_ACTIVITY_HOUSING,
+      project: TEST_HOUSING_PROJECT_1
+    }
+  };
+
   it('should call services and respond with 200 and paginated results', async () => {
     const req = {
       query: {
@@ -201,7 +210,7 @@ describe('searchPermitsController', () => {
     };
 
     const mockResponse = {
-      permits: TEST_PERMIT_LIST,
+      permits: [TEST_PERMIT_WITH_HOUSING_PROJECT],
       totalRecords: 25
     };
 
@@ -259,7 +268,7 @@ describe('searchPermitsController', () => {
     };
 
     const mockResponse = {
-      permits: [TEST_PERMIT_1],
+      permits: [TEST_PERMIT_WITH_HOUSING_PROJECT],
       totalRecords: 1
     };
 

app/tests/unit/services/permit.spec.ts

@@ -59,6 +59,11 @@ describe('listPermits', () => {
         }
       },
       include: {
+        activity: {
+          include: {
+            activityContact: true
+          }
+        },
         permitType: true,
         permitNote: false,
         permitTracking: {
@@ -245,6 +250,7 @@ describe('searchPermitsPaginated', () => {
         },
         activity: {
           include: {
+            activityContact: true,
             housingProject: true
           }
         }
@@ -293,6 +299,7 @@ describe('searchPermitsPaginated', () => {
           },
           activity: {
             include: {
+              activityContact: true,
               electrificationProject: true
             }
           }

frontend/src/types/api/resources.ts

@@ -373,13 +373,20 @@ interface PermitBase extends AuditFields {
 }
 
 interface PermitRelations {
+  activity: Activity;
   permitNote: PermitNote[];
   permitTracking: PermitTracking[];
   permitType: PermitType;
 }
 
 export type Permit = PermitBase & Partial<PermitRelations>;
 
+export interface PermitWithActivityProject extends Permit {
+  activity: Activity & {
+    project: ElectrificationProject | GeneralProject | HousingProject | null;
+  };
+}
+
 /**
  * Permit Note
  */

frontend/src/types/api/responses.ts

@@ -1,5 +1,5 @@
 import type { BasicResponse } from '@/utils/enums/application';
-import type { ActivityContact, Group, Permit } from './resources';
+import type { ActivityContact, Group, PermitWithActivityProject } from './resources';
 import type { SsoIdirUserAttributes } from '../oidc';
 import type { ContactPreference, ProjectRelationship } from '@/utils/enums/projectCommon';
 import type { CodeTableName } from '../common';
@@ -76,7 +76,7 @@ export interface ListIdirUsersResponse {
 }
 
 export interface SearchPermitsResponse {
-  permits: Permit[];
+  permits: PermitWithActivityProject[];
   totalRecords: number;
 }