feat(geoprocessing): pu-inclusion: process geojson

api/apps/api/src/modules/analysis/entry-points/adjust-planning-units-input.ts

@@ -1,14 +1,12 @@
-import { GeoJSON } from 'geojson';
+import { FeatureCollection, MultiPolygon, Polygon } from 'geojson';
 
 export interface AdjustPlanningUnitsInput {
   include?: {
     pu?: string[];
-    geo?: GeoJSON[];
-    shape?: GeoJSON[];
+    geo?: FeatureCollection<Polygon | MultiPolygon>[];
   };
   exclude?: {
     pu?: string[];
-    geo?: GeoJSON[];
-    shape?: GeoJSON[];
+    geo?: FeatureCollection<Polygon | MultiPolygon>[];
   };
 }

api/apps/api/src/modules/analysis/providers/planning-units/__mocks__/geojson.ts

@@ -1,11 +1,11 @@
-import { GeoJSON, MultiPolygon } from 'geojson';
+import { FeatureCollection, MultiPolygon } from 'geojson';
 
 const MultipolygonGeometry: MultiPolygon = Object.freeze({
   type: 'MultiPolygon',
   coordinates: [[[[0, 0]]]],
 });
 
-export const validGeoJson = (): GeoJSON => ({
+export const validGeoJson = (): FeatureCollection<MultiPolygon> => ({
   type: 'FeatureCollection',
   features: [
     {

api/apps/api/src/modules/scenarios/dto/__mocks__/geometry.ts

@@ -1,6 +1,6 @@
-import { FeatureCollection } from 'geojson';
+import { FeatureCollection, MultiPolygon } from 'geojson';
 
-export const invalidMultiPolygon = (): FeatureCollection => ({
+export const invalidMultiPolygon = (): FeatureCollection<MultiPolygon> => ({
   type: 'FeatureCollection',
   features: [
     {
@@ -22,7 +22,7 @@ export const invalidMultiPolygon = (): FeatureCollection => ({
   ],
 });
 
-export const sampleMultiPolygonJson = (): FeatureCollection => ({
+export const sampleMultiPolygonJson = (): FeatureCollection<MultiPolygon> => ({
   type: 'FeatureCollection',
   features: [
     {

api/apps/api/src/modules/scenarios/dto/update-scenario-planning-unit-lock-status.dto.ts

@@ -1,6 +1,6 @@
 import { IsOptional, IsUUID, ValidateNested } from 'class-validator';
 import { ApiPropertyOptional } from '@nestjs/swagger';
-import { FeatureCollection } from 'geojson';
+import { FeatureCollection, MultiPolygon, Polygon } from 'geojson';
 import { Type } from 'class-transformer';
 import { IsFeatureCollectionOfPolygons } from './is-feature-collection-of-polygons';
 
@@ -20,12 +20,12 @@ export class PlanningUnitsByGeoJsonUpdateDto {
   @ApiPropertyOptional()
   @IsOptional()
   @IsFeatureCollectionOfPolygons({ each: true })
-  include?: FeatureCollection[];
+  include?: FeatureCollection<MultiPolygon | Polygon>[];
 
   @ApiPropertyOptional()
   @IsOptional()
   @IsFeatureCollectionOfPolygons({ each: true })
-  exclude?: FeatureCollection[];
+  exclude?: FeatureCollection<MultiPolygon | Polygon>[];
 }
 
 export class UpdateScenarioPlanningUnitLockStatusDto {

api/apps/geoprocessing/src/modules/planning-units/planning-units.geo.entity.ts

@@ -2,21 +2,47 @@
  * @todo move the planningUnitsGeom entity to the api
  */
 import { ApiProperty } from '@nestjs/swagger';
-import { Column, Entity, PrimaryColumn } from 'typeorm';
+import { Column, Entity, PrimaryGeneratedColumn } from 'typeorm';
+import { Geometry } from 'geojson';
+import { defaultSrid } from '@marxan/utils/geo';
+
+export enum ShapeType {
+  Square = 'square',
+  Hexagon = 'hexagon',
+  Irregular = 'irregular',
+}
 
 @Entity('planning_units_geom')
 export class PlanningUnitsGeom {
   /**
    * id
    */
   @ApiProperty()
-  @PrimaryColumn('uuid', { name: 'id' })
+  @PrimaryGeneratedColumn('uuid', { name: 'id' })
   id!: string;
 
   /**
    * geometry column.
    */
   @ApiProperty()
-  @Column('geometry', { name: 'the_geom', select: false })
-  theGeom!: any;
+  @Column('geometry', {
+    name: 'the_geom',
+    select: false,
+    spatialFeatureType: 'MultiPolygon',
+    srid: defaultSrid,
+  })
+  theGeom!: Geometry;
+
+  @Column({
+    enum: ShapeType,
+    type: 'enum',
+    name: 'type',
+  })
+  type!: ShapeType;
+
+  @Column({
+    nullable: true,
+    type: 'int',
+  })
+  size?: number | undefined | null;
 }