413 Add Total Projects to capital projects endpoint

openapi/components/schemas/CapitalProjectPage.yaml

@@ -6,5 +6,11 @@ allOf:
         type: array
         items:
           $ref: ./CapitalProject.yaml
+      totalProjects:
+        type: integer
+        description: >-
+          The total number of results matching the query parameters.
+        minimum: 0
+        example: 212
     required:
       - capitalProjects

src/capital-project/capital-project.repository.ts

@@ -1,5 +1,5 @@
 import { Inject } from "@nestjs/common";
-import { isNotNull, sql, and, eq, sum, asc } from "drizzle-orm";
+import { isNotNull, sql, and, eq, sum, asc, count } from "drizzle-orm";
 import { DataRetrievalException } from "src/exception";
 import {
   CapitalProjectCategory,
@@ -91,6 +91,52 @@ export class CapitalProjectRepository {
     }
   }
 
+  async findCount({
+    cityCouncilDistrictId,
+    communityDistrictId,
+    boroughId,
+  }: {
+    cityCouncilDistrictId: string | null;
+    communityDistrictId: string | null;
+    boroughId: string | null;
+  }): Promise<number> {
+    try {
+      const countObject = await this.db
+        .select({
+          totalProjects: count(),
+        })
+        .from(capitalProject)
+        .leftJoin(
+          cityCouncilDistrict,
+          sql`
+            ST_Intersects(${cityCouncilDistrict.liFt}, ${capitalProject.liFtMPoly})
+            OR ST_Intersects(${cityCouncilDistrict.liFt}, ${capitalProject.liFtMPnt})`,
+        )
+        .leftJoin(
+          communityDistrict,
+          sql`
+          ST_Intersects(${communityDistrict.liFt}, ${capitalProject.liFtMPoly})
+          OR ST_Intersects(${communityDistrict.liFt}, ${capitalProject.liFtMPnt})`,
+        )
+        .where(
+          and(
+            cityCouncilDistrictId !== null
+              ? eq(cityCouncilDistrict.id, cityCouncilDistrictId)
+              : undefined,
+            communityDistrictId !== null && boroughId !== null
+              ? and(
+                  eq(communityDistrict.boroughId, boroughId),
+                  eq(communityDistrict.id, communityDistrictId),
+                )
+              : undefined,
+          ),
+        );
+      return countObject[0].totalProjects;
+    } catch {
+      throw new DataRetrievalException();
+    }
+  }
+
   #checkByManagingCodeCapitalProjectId = this.db.query.capitalProject
     .findFirst({
       columns: {

src/capital-project/capital-project.service.ts

@@ -73,11 +73,18 @@ export class CapitalProjectService {
       offset,
     });
 
+    const totalProjects = await this.capitalProjectRepository.findCount({
+      cityCouncilDistrictId,
+      boroughId,
+      communityDistrictId,
+    });
+
     return {
       capitalProjects,
       limit,
       offset,
       total: capitalProjects.length,
+      totalProjects,
       order: "managingCode, capitalProjectId",
     };
   }

src/gen/schemas/CapitalProjectPage.json

@@ -96,6 +96,12 @@
             ],
             "x-readme-ref-name": "CapitalProject"
           }
+        },
+        "totalProjects": {
+          "type": "integer",
+          "description": "The total number of results matching the query parameters.",
+          "minimum": 0,
+          "example": 212
         }
       },
       "required": ["capitalProjects"]

src/gen/types/CapitalProjectPage.ts

@@ -6,4 +6,9 @@ export type CapitalProjectPage = Page & {
    * @type array
    */
   capitalProjects: CapitalProject[];
+  /**
+   * @description The total number of results matching the query parameters.
+   * @type integer | undefined
+   */
+  totalProjects?: number;
 };

src/gen/zod/capitalProjectPageSchema.ts

@@ -5,5 +5,13 @@ import { z } from "zod";
 export const capitalProjectPageSchema = z
   .lazy(() => pageSchema)
   .and(
-    z.object({ capitalProjects: z.array(z.lazy(() => capitalProjectSchema)) }),
+    z.object({
+      capitalProjects: z.array(z.lazy(() => capitalProjectSchema)),
+      totalProjects: z.coerce
+        .number()
+        .int()
+        .min(0)
+        .describe("The total number of results matching the query parameters.")
+        .optional(),
+    }),
   );

test/capital-project/capital-project.repository.mock.ts

@@ -124,6 +124,37 @@ export class CapitalProjectRepositoryMock {
       .slice(offset, limit + offset);
   }
 
+  async findCount({
+    boroughId,
+    communityDistrictId,
+    cityCouncilDistrictId,
+  }: {
+    cityCouncilDistrictId: string | null;
+    communityDistrictId: string | null;
+    boroughId: string | null;
+  }) {
+    return this.findManyMocks.reduce(
+      (acc: FindManyRepo, [criteria, capitalProjects]) => {
+        if (
+          cityCouncilDistrictId !== null &&
+          criteria.cityCouncilDistrictId !== cityCouncilDistrictId
+        )
+          return acc;
+
+        if (boroughId !== null && criteria.boroughId !== boroughId) return acc;
+
+        if (
+          communityDistrictId !== null &&
+          criteria.communityDistrictId !== communityDistrictId
+        )
+          return acc;
+
+        return acc.concat(capitalProjects);
+      },
+      [],
+    ).length;
+  }
+
   checkByManagingCodeCapitalProjectIdMocks = Array.from(Array(5), (_, seed) =>
     generateMock(checkByManagingCodeCapitalProjectIdRepoSchema, {
       seed: seed + 1,