5577/property section backend

api/prisma/migrations/42_add_poperties_table/migration.sql

@@ -0,0 +1,26 @@
+-- AlterTable
+ALTER TABLE "listings" 
+ADD COLUMN "property_id" UUID;
+
+-- CreateTable
+CREATE TABLE "properties" (
+    "id" UUID NOT NULL DEFAULT uuid_generate_v4(),
+    "created_at" TIMESTAMP(6) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updated_at" TIMESTAMP(6) NOT NULL,
+    "name" TEXT NOT NULL,
+    "description" TEXT,
+    "url" TEXT,
+    "url_title" TEXT,
+    "jurisdiction_id" UUID,
+
+    CONSTRAINT "properties_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateIndex
+CREATE INDEX "properties_id_name_idx" ON "properties"("id", "name");
+
+-- AddForeignKey
+ALTER TABLE "listings" ADD CONSTRAINT "listings_property_id_fkey" FOREIGN KEY ("property_id") REFERENCES "properties"("id") ON DELETE SET NULL ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "properties" ADD CONSTRAINT "properties_jurisdiction_id_fkey" FOREIGN KEY ("jurisdiction_id") REFERENCES "jurisdictions"("id") ON DELETE NO ACTION ON UPDATE NO ACTION;

api/prisma/schema.prisma

@@ -403,6 +403,7 @@ model Jurisdictions {
   duplicateListingPermissions         UserRoleEnum[]              @map("duplicate_listing_permissions")
   requiredListingFields               String[]                    @default([]) @map("required_listing_fields")
   visibleNeighborhoodAmenities        NeighborhoodAmenitiesEnum[] @default([groceryStores, publicTransportation, schools, parksAndCommunityCenters, pharmacies, healthCareResources]) @map("visible_neighborhood_amenities")
+  properties                          Properties[]
 
   @@map("jurisdictions")
 }
@@ -736,6 +737,10 @@ model Listings {
   Listings                              Listings[]                    @relation("copy_of")
   lastUpdatedByUserId                   String?                       @map("last_updated_by_user_id") @db.Uuid
   lastUpdatedByUser                     UserAccounts?                 @relation("last_updated_by_user", fields: [lastUpdatedByUserId], references: [id], onDelete: NoAction, onUpdate: NoAction)
+  // START LA SPECIFIC
+  property                              Properties?                   @relation(fields: [propertyId], references: [id])
+  propertyId                            String?                       @map("property_id") @db.Uuid
+  // END LA SPECIFIC
 
   @@index([jurisdictionId])
   @@map("listings")
@@ -1101,6 +1106,26 @@ model UserPreferences {
 
 // END DETROIT SPECIFIC
 
+// START LA SPECIFIC
+
+model Properties {
+  id             String         @id() @default(dbgenerated("uuid_generate_v4()")) @db.Uuid
+  createdAt      DateTime       @default(now()) @map("created_at") @db.Timestamp(6)
+  updatedAt      DateTime       @updatedAt @map("updated_at") @db.Timestamp(6)
+  name           String
+  description    String?
+  url            String?
+  urlTitle       String?        @map("url_title")
+  jurisdictionId String?        @map("jurisdiction_id") @db.Uuid
+  listings       Listings[]
+  jurisdictions  Jurisdictions? @relation(fields: [jurisdictionId], references: [id], onDelete: NoAction, onUpdate: NoAction)
+
+  @@index([id, name])
+  @@map("properties")
+}
+
+// END LA SPECIFIC
+
 model ScriptRuns {
   id             String   @id() @default(dbgenerated("uuid_generate_v4()")) @db.Uuid
   createdAt      DateTime @default(now()) @map("created_at") @db.Timestamp(6)

api/src/controllers/listing.controller.ts

@@ -223,7 +223,7 @@ export class ListingController {
   @Get(`byMultiselectQuestion/:multiselectQuestionId`)
   @ApiOperation({
     summary: 'Get listings by multiselect question id',
-    operationId: 'retrieveListings',
+    operationId: 'retrieveListingsByMSQ',
   })
   @ApiOkResponse({ type: IdDTO, isArray: true })
   async retrieveListings(
@@ -234,6 +234,16 @@ export class ListingController {
     );
   }
 
+  @Get('byProperty/:propertyId')
+  @ApiOperation({
+    summary: 'Get listings by assigned porperty ID',
+    operationId: 'retrieveListingsByProperty',
+  })
+  @ApiOkResponse({ type: IdDTO, isArray: true })
+  async retreiveListingsByProperty(@Param('propertyId') propertyId: string) {
+    return await this.listingService.findListingsWithPorperty(propertyId);
+  }
+
   // NestJS best practice to have get(':id') at the bottom of the file
   @Get(`:id`)
   @ApiOperation({ summary: 'Get listing by id', operationId: 'retrieve' })

api/src/controllers/property.controller.ts

@@ -0,0 +1,139 @@
+import {
+  Body,
+  Controller,
+  Get,
+  Post,
+  Query,
+  Param,
+  ParseUUIDPipe,
+  Put,
+  UsePipes,
+  ValidationPipe,
+  Delete,
+  UseGuards,
+  Request,
+} from '@nestjs/common';
+import { Request as ExpressRequest } from 'express';
+import {
+  ApiExtraModels,
+  ApiOkResponse,
+  ApiOperation,
+  ApiTags,
+} from '@nestjs/swagger';
+import { PermissionTypeDecorator } from '../decorators/permission-type.decorator';
+import { PaginatedPropertyDto } from '../dtos/properties/paginated-property.dto';
+import { PropertyQueryParams } from '../dtos/properties/property-query-params.dto';
+import { PropertyService } from '../services/property.service';
+import PropertyCreate from '../dtos/properties/property-create.dto';
+import { PropertyUpdate } from '../dtos/properties/property-update.dto';
+import Property from '../dtos/properties/property.dto';
+import { IdDTO } from '../dtos/shared/id.dto';
+import { SuccessDTO } from '../dtos/shared/success.dto';
+import { defaultValidationPipeOptions } from '../utilities/default-validation-pipe-options';
+import { OptionalAuthGuard } from '../guards/optional.guard';
+import { mapTo } from '../utilities/mapTo';
+import { User } from '../dtos/users/user.dto';
+import { PaginationMeta } from '../dtos/shared/pagination.dto';
+import { PropertyFilterParams } from '../dtos/properties/property-filter-params.dto';
+
+@Controller('properties')
+@ApiTags('properties')
+@UseGuards(OptionalAuthGuard)
+@ApiExtraModels(
+  PropertyCreate,
+  PropertyUpdate,
+  PropertyQueryParams,
+  PropertyFilterParams,
+  PaginationMeta,
+  IdDTO,
+)
+@PermissionTypeDecorator('property')
+export class PropertyController {
+  constructor(private readonly propertyService: PropertyService) {}
+
+  @Get()
+  @ApiOperation({
+    summary: 'Get a paginated set of properties',
+    operationId: 'list',
+  })
+  @UsePipes(new ValidationPipe(defaultValidationPipeOptions))
+  @ApiOkResponse({ type: PaginatedPropertyDto })
+  public async getPaginatedSet(@Query() queryParams: PropertyQueryParams) {
+    return await this.propertyService.list(queryParams);
+  }
+
+  @Get(':id')
+  @ApiOperation({
+    summary: 'Get a property object by ID',
+    operationId: 'getById',
+  })
+  public async getPropertyById(
+    @Param('id', new ParseUUIDPipe({ version: '4' })) propertyId: string,
+  ) {
+    return this.propertyService.findOne(propertyId);
+  }
+
+  @Post('list')
+  @ApiOperation({
+    summary: 'Get a paginated filtered set of properties',
+    operationId: 'filterableList',
+  })
+  @UsePipes(new ValidationPipe(defaultValidationPipeOptions))
+  @ApiOkResponse({ type: PaginatedPropertyDto })
+  public async getFiltrablePaginatedSet(
+    @Body() queryParams: PropertyQueryParams,
+  ) {
+    return await this.propertyService.list(queryParams);
+  }
+
+  @Post()
+  @ApiOperation({
+    summary: 'Add a new property entry',
+    operationId: 'add',
+  })
+  @UsePipes(new ValidationPipe(defaultValidationPipeOptions))
+  @ApiOkResponse({ type: Property })
+  public async addProperty(
+    @Request() req: ExpressRequest,
+    @Body() propertyDto: PropertyCreate,
+  ) {
+    return await this.propertyService.create(
+      propertyDto,
+      mapTo(User, req['user']),
+    );
+  }
+
+  @Put()
+  @ApiOperation({
+    summary: 'Update an exiting property entry by id',
+    operationId: 'update',
+  })
+  @UsePipes(new ValidationPipe(defaultValidationPipeOptions))
+  @ApiOkResponse({ type: Property })
+  public async updateProperty(
+    @Request() req: ExpressRequest,
+    @Body() propertyDto: PropertyUpdate,
+  ) {
+    return await this.propertyService.update(
+      propertyDto,
+      mapTo(User, req['user']),
+    );
+  }
+
+  @Delete()
+  @ApiOperation({
+    summary: 'Delete an property entry by ID',
+    operationId: 'deleteById',
+  })
+  @UsePipes(new ValidationPipe(defaultValidationPipeOptions))
+  @ApiOkResponse({ type: SuccessDTO })
+  public async deleteById(
+    @Request() req: ExpressRequest,
+    @Body() idDto: IdDTO,
+  ) {
+    return await this.propertyService.deleteOne(
+      idDto.id,
+      mapTo(User, req['user']),
+    );
+  }
+}

api/src/dtos/listings/listing.dto.ts

@@ -63,6 +63,7 @@ import {
 import { ValidateListingDeposit } from '../../decorators/validate-listing-deposit.decorator';
 import { ListingDocuments } from './listing-documents.dto';
 import { ValidateListingImages } from '../../decorators/validate-listing-images.decorator';
+import Property from '../properties/property.dto';
 
 class Listing extends AbstractDTO {
   @Expose()
@@ -1165,6 +1166,15 @@ class Listing extends AbstractDTO {
     },
   )
   lastUpdatedByUser?: IdDTO;
+
+  @Expose()
+  @ValidateListingPublish('property', {
+    groups: [ValidationsGroupsEnum.default],
+  })
+  @ValidateNested({ groups: [ValidationsGroupsEnum.default] })
+  @Type(() => Property)
+  @ApiPropertyOptional({ type: Property })
+  property?: Property;
 }
 
 export { Listing as default, Listing };

api/src/dtos/properties/paginated-property.dto.ts

@@ -0,0 +1,6 @@
+import { PaginationFactory } from '../shared/pagination.dto';
+import Property from './property.dto';
+
+export class PaginatedPropertyDto extends PaginationFactory<Property>(
+  Property,
+) {}

api/src/dtos/properties/property-create.dto.ts

@@ -0,0 +1,8 @@
+import { OmitType } from '@nestjs/swagger';
+import Property from './property.dto';
+
+export default class PropertyCreate extends OmitType(Property, [
+  'id',
+  'createdAt',
+  'updatedAt',
+]) {}

api/src/dtos/properties/property-filter-params.dto.ts

@@ -0,0 +1,14 @@
+import { Expose } from 'class-transformer';
+import { BaseFilter } from '../shared/base-filter.dto';
+import { ApiPropertyOptional } from '@nestjs/swagger';
+import { IsString } from 'class-validator';
+import { ValidationsGroupsEnum } from '../../enums/shared/validation-groups-enum';
+
+export class PropertyFilterParams extends BaseFilter {
+  @Expose()
+  @ApiPropertyOptional({
+    example: 'uuid',
+  })
+  @IsString({ groups: [ValidationsGroupsEnum.default] })
+  jurisdiction?: string;
+}

api/src/dtos/properties/property-query-params.dto.ts

@@ -0,0 +1,27 @@
+import { Expose, Type } from 'class-transformer';
+import { PaginationAllowsAllQueryParams } from '../shared/pagination.dto';
+import { ApiPropertyOptional } from '@nestjs/swagger';
+import { IsArray, MinLength, ValidateNested } from 'class-validator';
+import { ValidationsGroupsEnum } from '../../enums/shared/validation-groups-enum';
+import { PropertyFilterParams } from './property-filter-params.dto';
+
+export class PropertyQueryParams extends PaginationAllowsAllQueryParams {
+  @Expose()
+  @ApiPropertyOptional({
+    example: 'search',
+  })
+  @MinLength(3, {
+    message: 'Search must be at least 3 characters',
+    groups: [ValidationsGroupsEnum.default],
+  })
+  search?: string;
+
+  @Expose()
+  @ApiPropertyOptional({
+    type: [String],
+  })
+  @IsArray({ groups: [ValidationsGroupsEnum.default] })
+  @Type(() => PropertyFilterParams)
+  @ValidateNested({ groups: [ValidationsGroupsEnum.default], each: true })
+  filter?: PropertyFilterParams[];
+}

api/src/dtos/properties/property-update.dto.ts

@@ -0,0 +1,16 @@
+import { ApiPropertyOptional, OmitType } from '@nestjs/swagger';
+import Property from './property.dto';
+import { Expose } from 'class-transformer';
+import { IsString } from 'class-validator';
+import { ValidationsGroupsEnum } from '../../enums/shared/validation-groups-enum';
+
+export class PropertyUpdate extends OmitType(Property, [
+  'createdAt',
+  'updatedAt',
+  'name',
+]) {
+  @Expose()
+  @IsString({ groups: [ValidationsGroupsEnum.default] })
+  @ApiPropertyOptional()
+  name?: string;
+}

api/src/dtos/properties/property.dto.ts

@@ -0,0 +1,39 @@
+import { Expose, Type } from 'class-transformer';
+import { AbstractDTO } from '../shared/abstract.dto';
+import { IsDefined, IsString, IsUrl, ValidateNested } from 'class-validator';
+import { ValidationsGroupsEnum } from '../../enums/shared/validation-groups-enum';
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import { IdDTO } from '../shared/id.dto';
+
+export default class Property extends AbstractDTO {
+  @Expose()
+  @IsDefined({ groups: [ValidationsGroupsEnum.default] })
+  @IsString({ groups: [ValidationsGroupsEnum.default] })
+  @ApiProperty()
+  name: string;
+
+  @Expose()
+  @IsString({ groups: [ValidationsGroupsEnum.default] })
+  @ApiPropertyOptional()
+  description?: string;
+
+  @Expose()
+  @IsString({ groups: [ValidationsGroupsEnum.default] })
+  @IsUrl(
+    { require_protocol: true },
+    { groups: [ValidationsGroupsEnum.default] },
+  )
+  @ApiPropertyOptional()
+  url?: string;
+
+  @Expose()
+  @IsString({ groups: [ValidationsGroupsEnum.default] })
+  @ApiPropertyOptional()
+  urlTitle?: string;
+
+  @Expose()
+  @ValidateNested({ groups: [ValidationsGroupsEnum.default] })
+  @Type(() => IdDTO)
+  @ApiPropertyOptional({ type: IdDTO })
+  jurisdictions?: IdDTO;
+}