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

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

@@ -4,18 +4,16 @@ import { PaginatedQueryBuilder } from "@terramatch-microservices/common/util/pag
 import { DemographicQueryDto } from "./dto/demographic-query.dto";
 import { Model, ModelStatic, Op } from "sequelize";
 
+type DemographicFilter<T extends Model = Model> = {
+  uuidKey: string;
+  model: ModelStatic<T>;
+  laravelType: string;
+};
+
 @Injectable()
 export class DemographicService {
   async getDemographics(query: DemographicQueryDto) {
-    const builder = PaginatedQueryBuilder.forNumberPage(Demographic, query);
-
-    type DemographicFilter<T extends Model = Model> = {
-      uuidKey: string;
-      model: ModelStatic<T>;
-      laravelType: string;
-    };
-
-    const demographicFilters: DemographicFilter[] = [
+    const DEMOGRAPHIC_FILTERS: DemographicFilter[] = [
       {
         uuidKey: "projectUuid",
         model: Project,
@@ -31,16 +29,20 @@ export class DemographicService {
         model: SiteReport,
         laravelType: SiteReport.LARAVEL_TYPE
       }
-    ];
+    ] as const;
+
+    const builder = PaginatedQueryBuilder.forNumberPage(Demographic, query);
+
+    const VALID_FILTER_KEYS = DEMOGRAPHIC_FILTERS.map(({ uuidKey }) => uuidKey);
 
-    Object.entries(query).forEach(([key]) => {
+    Object.keys(query).forEach(key => {
       if (key === "page" || key === "sort") return;
-      if (!demographicFilters.map(d => d.uuidKey).includes(key)) {
+      if (!VALID_FILTER_KEYS.includes(key)) {
         throw new BadRequestException(`Invalid filter key: ${key}`);
       }
     });
 
-    for (const { uuidKey, model, laravelType } of demographicFilters) {
+    for (const { uuidKey, model, laravelType } of DEMOGRAPHIC_FILTERS) {
       const uuids = query[uuidKey];
       if (uuids != null && uuids.length > 0) {
         const records = (await model.findAll({

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

@@ -3,7 +3,7 @@ import { buildJsonApi, getStableRequestQuery } from "@terramatch-microservices/c
 import { ApiOperation } from "@nestjs/swagger";
 import { ExceptionResponse, JsonApiResponse } from "@terramatch-microservices/common/decorators";
 import { PolicyService } from "@terramatch-microservices/common";
-import { DemographicDto, DemographicDtoV2 } from "./dto/demographic.dto";
+import { DemographicDto } from "./dto/demographic.dto";
 import { DemographicQueryDto } from "./dto/demographic-query.dto";
 import { DemographicService } from "./demographic.service";
 
@@ -27,7 +27,7 @@ export class DemographicsController {
       await this.policyService.authorize("read", data);
       for (const demographic of data) {
         indexIds.push(demographic.uuid);
-        const demographicDto = new DemographicDtoV2(demographic);
+        const demographicDto = new DemographicDto(demographic);
         document.addData(demographicDto.uuid, demographicDto);
       }
     }

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

@@ -1,27 +1,9 @@
 import { ApiProperty, IntersectionType } from "@nestjs/swagger";
-import { IsArray, IsEnum, IsOptional, ValidateNested } from "class-validator";
+import { IsArray, IsOptional } from "class-validator";
 import { NumberPage } from "@terramatch-microservices/common/dto/page.dto";
+import { IndexQueryDto } from "./index-query.dto";
 
-class QuerySort {
-  @ApiProperty({ name: "sort[field]", required: false })
-  @IsOptional()
-  field?: string;
-
-  @ApiProperty({ name: "sort[direction]", required: false, enum: ["ASC", "DESC"], default: "ASC" })
-  @IsEnum(["ASC", "DESC"])
-  @IsOptional()
-  direction?: "ASC" | "DESC";
-}
-
-export class DemographicQueryDto extends IntersectionType(QuerySort, NumberPage) {
-  @ValidateNested()
-  @IsOptional()
-  page?: NumberPage;
-
-  @ValidateNested()
-  @IsOptional()
-  sort?: QuerySort;
-
+export class DemographicQueryDto extends IntersectionType(IndexQueryDto, NumberPage) {
   @ApiProperty({ required: false, isArray: true, description: "project uuid array" })
   @IsOptional()
   @IsArray()

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

@@ -75,31 +75,19 @@ export class DemographicEntryDto {
 
 @JsonApiDto({ type: "demographics" })
 export class DemographicDto extends AssociationDto {
-  constructor(demographic: Demographic, additional: AdditionalProps<DemographicDto, Demographic>) {
+  constructor(demographic: Demographic, additional: AdditionalProps<DemographicDto, Demographic>);
+  constructor(demographic: Demographic);
+  constructor(demographic: Demographic, additional?: AdditionalProps<DemographicDto, Demographic>) {
     super();
-    populateDto<DemographicDto, Omit<Demographic, "entries">>(this, demographic, {
-      ...additional,
-      entries: demographic.entries?.map(entry => new DemographicEntryDto(entry)) ?? []
-    });
-  }
-
-  @ApiProperty()
-  uuid: string;
 
-  @ApiProperty({ enum: Demographic.VALID_TYPES })
-  type: string;
-
-  @ApiProperty()
-  collection: string;
-
-  @ApiProperty({ type: () => DemographicEntryDto, isArray: true })
-  entries: DemographicEntryDto[];
-}
-
-@JsonApiDto({ type: "demographics" })
-export class DemographicDtoV2 {
-  constructor(data: Demographic) {
-    populateDto<DemographicDtoV2>(this, data as DemographicDtoV2);
+    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);
+    }
   }
 
   @ApiProperty()