[TM-2084] Move demographics new controller and support querying

apps/entity-service/src/app.module.ts

@@ -19,6 +19,8 @@ import { BoundingBoxService } from "./bounding-boxes/bounding-box.service";
 import { DataApiModule } from "@terramatch-microservices/data-api";
 import { DemographicsController } from "./entities/demographics.controller";
 import { DemographicService } from "./entities/demographic.service";
+import { ImpactStoriesController } from "./entities/impact-stories.controller";
+import { ImpactStoryService } from "./entities/impact-story.service";
 
 @Module({
   imports: [SentryModule.forRoot(), CommonModule, HealthModule, DataApiModule],

apps/entity-service/src/entities/demographic.controller.spec.ts

@@ -12,6 +12,7 @@ describe("DemographicsController", () => {
   let controller: DemographicsController;
   let demographicService: DeepMocked<DemographicService>;
   let policyService: DeepMocked<PolicyService>;
+  const LARAVEL_TYPE = "App\\Models\\V2\\Projects\\Project";
 
   beforeEach(async () => {
     const module = await Test.createTestingModule({
@@ -48,8 +49,18 @@ describe("DemographicsController", () => {
     it("should return an array of 3 demographics successfully", async () => {
       const mockResponse = {
         data: [
-          new Demographic({ uuid: "1", type: "type 1" } as Demographic),
-          new Demographic({ uuid: "2", type: "type 2" } as Demographic)
+          new Demographic({
+            uuid: "1",
+            type: "type 1",
+            demographicalType: LARAVEL_TYPE,
+            demographicalId: 1
+          } as Demographic),
+          new Demographic({
+            uuid: "2",
+            type: "type 2",
+            demographicalType: LARAVEL_TYPE,
+            demographicalId: 2
+          } as Demographic)
         ],
         paginationTotal: 3,
         pageNumber: 1

apps/entity-service/src/entities/demographic.service.ts

@@ -10,31 +10,31 @@ type DemographicFilter<T extends Model = Model> = {
   laravelType: string;
 };
 
+const DEMOGRAPHIC_FILTERS: DemographicFilter[] = [
+  {
+    uuidKey: "projectUuid",
+    model: Project,
+    laravelType: Project.LARAVEL_TYPE
+  },
+  {
+    uuidKey: "projectReportUuid",
+    model: ProjectReport,
+    laravelType: ProjectReport.LARAVEL_TYPE
+  },
+  {
+    uuidKey: "siteReportUuid",
+    model: SiteReport,
+    laravelType: SiteReport.LARAVEL_TYPE
+  }
+] as const;
+
+const VALID_FILTER_KEYS = DEMOGRAPHIC_FILTERS.map(({ uuidKey }) => uuidKey);
+
 @Injectable()
 export class DemographicService {
   async getDemographics(query: DemographicQueryDto) {
-    const DEMOGRAPHIC_FILTERS: DemographicFilter[] = [
-      {
-        uuidKey: "projectUuid",
-        model: Project,
-        laravelType: Project.LARAVEL_TYPE
-      },
-      {
-        uuidKey: "projectReportUuid",
-        model: ProjectReport,
-        laravelType: ProjectReport.LARAVEL_TYPE
-      },
-      {
-        uuidKey: "siteReportUuid",
-        model: SiteReport,
-        laravelType: SiteReport.LARAVEL_TYPE
-      }
-    ] as const;
-
     const builder = PaginatedQueryBuilder.forNumberPage(Demographic, query);
 
-    const VALID_FILTER_KEYS = DEMOGRAPHIC_FILTERS.map(({ uuidKey }) => uuidKey);
-
     Object.keys(query).forEach(key => {
       if (key === "page" || key === "sort") return;
       if (!VALID_FILTER_KEYS.includes(key)) {

apps/entity-service/src/entities/demographics.controller.ts

@@ -6,6 +6,7 @@ import { PolicyService } from "@terramatch-microservices/common";
 import { DemographicDto } from "./dto/demographic.dto";
 import { DemographicQueryDto } from "./dto/demographic-query.dto";
 import { DemographicService } from "./demographic.service";
+import { LARAVEL_MODELS } from "@terramatch-microservices/database/constants/laravel-types";
 
 @Controller("entities/v3/demographics")
 export class DemographicsController {
@@ -27,7 +28,12 @@ export class DemographicsController {
       await this.policyService.authorize("read", data);
       for (const demographic of data) {
         indexIds.push(demographic.uuid);
-        const demographicDto = new DemographicDto(demographic);
+        const model = LARAVEL_MODELS[demographic.demographicalType];
+        const demographicData = await model.findOne({
+          where: { id: demographic.demographicalId },
+          attributes: ["id", "uuid"]
+        });
+        const demographicDto = new DemographicDto(demographic, demographicData);
         document.addData(demographicDto.uuid, demographicDto);
       }
     }

apps/entity-service/src/entities/dto/demographic-query.dto.ts

@@ -1,9 +1,8 @@
-import { ApiProperty, IntersectionType } from "@nestjs/swagger";
+import { ApiProperty } from "@nestjs/swagger";
 import { IsArray, IsOptional } from "class-validator";
-import { NumberPage } from "@terramatch-microservices/common/dto/page.dto";
 import { IndexQueryDto } from "./index-query.dto";
 
-export class DemographicQueryDto extends IntersectionType(IndexQueryDto, NumberPage) {
+export class DemographicQueryDto extends IndexQueryDto {
   @ApiProperty({ required: false, isArray: true, description: "project uuid array" })
   @IsOptional()
   @IsArray()

apps/entity-service/src/entities/dto/demographic.dto.ts

@@ -75,19 +75,12 @@ export class DemographicEntryDto {
 
 @JsonApiDto({ type: "demographics" })
 export class DemographicDto extends AssociationDto {
-  constructor(demographic: Demographic, additional: AdditionalProps<DemographicDto, Demographic>);
-  constructor(demographic: Demographic);
-  constructor(demographic: Demographic, additional?: AdditionalProps<DemographicDto, Demographic>) {
+  constructor(demographic: Demographic, additional: AdditionalProps<DemographicDto, Demographic>) {
     super();
-
-    if (additional != null) {
-      populateDto<DemographicDto, Omit<Demographic, "entries">>(this, demographic, {
-        ...additional,
-        entries: demographic.entries?.map(entry => new DemographicEntryDto(entry)) ?? []
-      });
-    } else {
-      populateDto<DemographicDto>(this, demographic as unknown as DemographicDto);
-    }
+    populateDto<DemographicDto, Omit<Demographic, "entries">>(this, demographic, {
+      ...additional,
+      entries: demographic.entries?.map(entry => new DemographicEntryDto(entry)) ?? []
+    });
   }
 
   @ApiProperty()

libs/common/src/lib/policies/policy.service.ts

@@ -36,6 +36,12 @@ import { TMLogger } from "../util/tm-logger";
 import { ProjectPitchPolicy } from "./project-pitch.policy";
 import { TaskPolicy } from "./task.policy";
 import { DemographicPolicy } from "./demographic.policy";
+import { AuditStatusPolicy } from "./audit-status.policy";
+import { FinancialIndicatorPolicy } from "./financial-indicator.policy";
+import { FormPolicy } from "./form.policy";
+import { FormQuestionOptionPolicy } from "./form-question-option.policy";
+import { FundingProgrammePolicy } from "./funding-programme.policy";
+import { ImpactStoryPolicy } from "./impact-story.policy";
 
 type EntityClass = {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -58,7 +64,13 @@ const POLICIES: [EntityClass, PolicyClass][] = [
   [User, UserPolicy],
   [ProjectPitch, ProjectPitchPolicy],
   [Task, TaskPolicy],
-  [Demographic, DemographicPolicy]
+  [Demographic, DemographicPolicy],
+  [AuditStatus, AuditStatusPolicy],
+  [FinancialIndicator, FinancialIndicatorPolicy],
+  [Form, FormPolicy],
+  [FormQuestionOption, FormQuestionOptionPolicy],
+  [FundingProgramme, FundingProgrammePolicy],
+  [ImpactStory, ImpactStoryPolicy]
 ];
 
 /**

libs/database/src/lib/constants/laravel-types.ts

@@ -0,0 +1,9 @@
+import { Organisation, Project, ProjectPitch, ProjectReport, SiteReport } from "../entities";
+
+export const LARAVEL_MODELS = {
+  [Organisation.LARAVEL_TYPE]: Organisation,
+  [Project.LARAVEL_TYPE]: Project,
+  [ProjectPitch.LARAVEL_TYPE]: ProjectPitch,
+  [ProjectReport.LARAVEL_TYPE]: ProjectReport,
+  [SiteReport.LARAVEL_TYPE]: SiteReport
+};