feat: non-regulated fields implementation (#5455)

* fix: fix schema formatting
* chore: add new enum types
* chore: add new Listings model fields
* chore: add new fields to the UnitGroup model
* chore: update DTO's to changes in schema
* chore: generate new swagger types
* chore: add migration for new schema updates
* fix: update depositValue field decimal range
* fix: add missing field names
* chore: add custom deposit validation decorator
* chore: add unit group rent type validation
* fix: remove unnecessary import
* chore: update sunit summary DTO to contain new fields
* chore: update service layer
* fix: remove unnecessary migration update
* fix: update db fields
* chore: update rent validation decorator
* chore: add the cocInfo to the listing DTO
* chore: regenerate backend swagger
* chore: add listing type selector
* chore: add unit form non regulated rent fields
* fix: fix invalid logic
* chore: update prop to and optional value
* chore: add rent type fields for unit group form
* chore: hide additional fields for non regulated listings
* chore: add fields for the deposit types
* chore: update labels
* chore: update community types fields
* chore: add listing ebll clearance field
* chore: update built year filed rendering logic
* chore: fix field decorator error
* fix: fix decorators import paths
* chore: update required documents form fields
* chore: update the schema to include the new required documents list table
* fix: remove unused import
* chore: update listings factory to include the new required documents field
* chore: hide non regulated switch field based on feature flag
* chore: retain the original required documents field
* Revert "chore: hide non regulated switch field based on feature flag"

This reverts commit 11f0874.
* fix: add missing fields validation
* fix: update imports
* fix: remove the package manager filed in package JSON
* fix: update the hasHudEbllClearance field
* fix: remove unused import
* chore: update the label to match the current listing type
* fix: fix the application fee full width field
* fix: hide the new deposit and rent fields for regulated units
* fix: boolean ebll formatting for form submission
* chore: add non regulated listing fields to intro and fees sections
* chore: add missing documents model column mapping
* fix: udpdate form subssion for the new required documents field
* chore: add required documents preview in the details
* fix: add feature flag based regulated fields control
* chore: update the validation decorator
* chore: update listing details page to new jest standard
* fix: fix failing backend API tests
* fix: fix backend integration tests
* fix: fix decorator logic
* fix: add unit group rent range revalidation triggering
* fix: fix unwanted initial ebll field reset
* fix: required documents preview filtering
* fix: update the developer field title switching on listing preview page
* fix: hide new fields on listing preview based on the non-regulated feature flag
* fix: fix label typo
* fix: update new required documents field label formatting
* fix: hide the new documents field group on regulated listings
* fix: remove unused import
* fix: add missing monthly rent field to database
* fix: fix unit groups integration tests
* fix: paper listing form failing tests
* chore: rename migration files
* fix: clean-up merge conflict resolve
* fix: remove unnecessary listing service code
* fix: hide the new required documents field from preview page based on feature flag
* fix: remove unused prop
* fix: update the listings factory to add new required documents only for non regulated mocks
* chore: add logic to disconnect and delete documents table entry automatically
* fix: fix Units component feature flag detection code
* chore: add integration tests for non regulated listing preview
* chore: add integration tests for the ListingIntro section
* chore: add integration tests for AdditionalDetails form section component
* chore: add deposit type default field for the listing form
* chore: add integration tests for the AdditionalFees listing form component
* chore: add integration tests for the unit group form for non-regulated listing
* fix: update the listing service to remove the documents entry after completed transaction
* fix: revert the CommunityType component logic
* chore: partially revert additional fees section logic
* fix: update the listingType field clearing to undefined
* fix: remove unused imports
* fix: revert changes for unit form
* test: re-run testing suite
* chore: remove the depositRangeMin and depositRangeMax fields
* chore: update the data formatter to handle different deposit type values
* fix: update api integration tests to new changes
* fix: fix csv export integration tests
* test: re-run testing suite
* fix: update partners site integration tests
* test: re-run testing suite
* fix: remove unnecessary console log
* fix: clear deposit on save and continue (#5598)

---------

Co-authored-by: Morgan Ludtke <42942267+ludtkemorgan@users.noreply.github.com>

Author: matzduniuk

api/prisma/migrations/32_add_non_regulated_listings_fields/migration.sql

@@ -10,8 +10,6 @@ CREATE TYPE "rent_type_enum" AS ENUM ('fixedRent', 'rentRange');
 -- AlterTable
 ALTER TABLE "listings" 
 ADD COLUMN     "coc_info" TEXT,
-ADD COLUMN     "deposit_range_max" INTEGER,
-ADD COLUMN     "deposit_range_min" INTEGER,
 ADD COLUMN     "deposit_type" "deposit_type_enum",
 ADD COLUMN     "deposit_value" DECIMAL(65,30),
 ADD COLUMN     "has_hud_ebll_clearance" BOOLEAN,

api/prisma/migrations/37_add_required_documents_list_model/migration.sql

@@ -0,0 +1,26 @@
+-- AlterTable
+ALTER TABLE "listings" ADD COLUMN "documents_id" UUID;
+
+-- CreateTable
+CREATE TABLE "listing_documents" (
+    "id" UUID NOT NULL DEFAULT uuid_generate_v4(),
+    "created_at" TIMESTAMP(6) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updated_at" TIMESTAMP(6) NOT NULL,
+    "birth_certificate" BOOLEAN,
+    "current_landlord_reference" BOOLEAN,
+    "government_issued_id" BOOLEAN,
+    "previous_landlord_reference" BOOLEAN,
+    "proof_of_assets" BOOLEAN,
+    "proof_of_custody" BOOLEAN,
+    "proof_of_income" BOOLEAN,
+    "residency_documents" BOOLEAN,
+    "social_security_card" BOOLEAN,
+
+    CONSTRAINT "listing_documents_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateIndex
+CREATE UNIQUE INDEX "listings_documents_id_key" ON "listings"("documents_id");
+
+-- AddForeignKey
+ALTER TABLE "listings" ADD CONSTRAINT "listings_documents_id_fkey" FOREIGN KEY ("documents_id") REFERENCES "listing_documents"("id") ON DELETE NO ACTION ON UPDATE NO ACTION;

api/prisma/migrations/38_add_monthly_rent_to_unit_group/migration.sql

@@ -0,0 +1,4 @@
+ALTER TABLE "unit_group" 
+ADD COLUMN "monthly_rent" DECIMAL,
+ALTER COLUMN "flat_rent_value_from" SET DATA TYPE DECIMAL,
+ALTER COLUMN "flat_rent_value_to" SET DATA TYPE DECIMAL;

api/prisma/schema.prisma

@@ -527,6 +527,24 @@ model ListingUtilities {
   @@map("listing_utilities")
 }
 
+model ListingDocuments {
+  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)
+  socialSecurityCard        Boolean?  @map("social_security_card")
+  currentLandlordReference  Boolean?  @map("current_landlord_reference")
+  birthCertificate          Boolean?  @map("birth_certificate")
+  previousLandlordReference Boolean?  @map("previous_landlord_reference")
+  governmentIssuedId        Boolean?  @map("government_issued_id")
+  proofOfAssets             Boolean?  @map("proof_of_assets")
+  proofOfIncome             Boolean?  @map("proof_of_income")
+  residencyDocuments        Boolean?  @map("residency_documents")
+  proofOfCustody            Boolean?  @map("proof_of_custody")
+  listings                  Listings?
+
+  @@map("listing_documents")
+}
+
 enum ListingTypeEnum {
   regulated
   nonRegulated
@@ -594,8 +612,6 @@ model Listings {
   depositMax                            String?                       @map("deposit_max")
   depositType                           DepositTypeEnum?              @map("deposit_type")
   depositValue                          Decimal?                      @map("deposit_value") @db.Decimal(8, 2)
-  depositRangeMin                       Int?                          @map("deposit_range_min")
-  depositRangeMax                       Int?                          @map("deposit_range_max")
   depositHelperText                     String?                       @map("deposit_helper_text")
   disableUnitsAccordion                 Boolean?                      @map("disable_units_accordion")
   hasHudEbllClearance                   Boolean?                      @map("has_hud_ebll_clearance")
@@ -611,6 +627,7 @@ model Listings {
   rentalAssistance                      String?                       @map("rental_assistance")
   rentalHistory                         String?                       @map("rental_history")
   requiredDocuments                     String?                       @map("required_documents")
+  requiredDocumentsList                 ListingDocuments?             @relation(fields: [documentsId], references: [id], onDelete: NoAction, onUpdate: NoAction)
   specialNotes                          String?                       @map("special_notes")
   waitlistCurrentSize                   Int?                          @map("waitlist_current_size")
   waitlistMaxSize                       Int?                          @map("waitlist_max_size")
@@ -644,6 +661,7 @@ model Listings {
   resultId                              String?                       @map("result_id") @db.Uuid
   featuresId                            String?                       @unique() @map("features_id") @db.Uuid
   utilitiesId                           String?                       @unique() @map("utilities_id") @db.Uuid
+  documentsId                           String?                       @unique() @map("documents_id") @db.Uuid
   includeCommunityDisclaimer            Boolean?                      @map("include_community_disclaimer")
   communityDisclaimerTitle              String?                       @map("community_disclaimer_title")
   communityDisclaimerDescription        String?                       @map("community_disclaimer_description")
@@ -1016,8 +1034,9 @@ model UnitGroup {
   updatedAt                      DateTime                        @default(now()) @updatedAt @map("updated_at") @db.Timestamp(6)
   maxOccupancy                   Int?                            @map("max_occupancy")
   minOccupancy                   Int?                            @map("min_occupancy")
-  flatRentValueFrom              Decimal?                        @map("flat_rent_value_from")
-  flatRentValueTo                Decimal?                        @map("flat_rent_value_to")
+  flatRentValueFrom              Decimal?                        @map("flat_rent_value_from") @db.Decimal
+  flatRentValueTo                Decimal?                        @map("flat_rent_value_to") @db.Decimal
+  monthlyRent                    Decimal?                        @map("monthly_rent") @db.Decimal
   floorMin                       Int?                            @map("floor_min")
   floorMax                       Int?                            @map("floor_max")
   totalCount                     Int?                            @map("total_count")

api/prisma/seed-helpers/listing-factory.ts

@@ -8,6 +8,7 @@ import {
   PrismaClient,
   ReservedCommunityTypes,
   ReviewOrderTypeEnum,
+  ListingTypeEnum,
 } from '@prisma/client';
 import { randomInt } from 'crypto';
 import dayjs from 'dayjs';
@@ -51,6 +52,18 @@ type optionalFeatures = {
   loweredCabinets?: boolean;
 };
 
+type requiredDocuments = {
+  socialSecurityCard?: boolean;
+  currentLandlordReference?: boolean;
+  birthCertificate?: boolean;
+  previousLandlordReference?: boolean;
+  governmentIssuedId?: boolean;
+  proofOfAssets?: boolean;
+  proofOfIncome?: boolean;
+  residencyDocuments?: boolean;
+  proofOfCustody?: boolean;
+};
+
 type optionalUtilities = {
   water?: boolean;
   gas?: boolean;
@@ -89,6 +102,7 @@ export const listingFactory = async (
     unitGroups?: Prisma.UnitGroupCreateWithoutListingsInput[];
     units?: Prisma.UnitsCreateWithoutListingsInput[];
     userAccounts?: Prisma.UserAccountsWhereUniqueInput[];
+    requiredDocumentsList?: requiredDocuments;
   },
 ): Promise<Prisma.ListingsCreateInput> => {
   const previousListing = optionalParams?.listing || {};
@@ -260,6 +274,9 @@ export const listingFactory = async (
       optionalParams?.optionalFeatures,
       optionalParams?.optionalUtilities,
     ),
+    ...(optionalParams?.listing?.listingType === ListingTypeEnum.nonRegulated
+      ? listingsRequiredDocuments(optionalParams?.requiredDocumentsList)
+      : {}),
     ...previousListing,
   };
 };
@@ -289,6 +306,27 @@ const buildingFeatures = (includeBuildingFeatures: boolean) => {
   };
 };
 
+export const listingsRequiredDocuments = (
+  requiredDocumentsList?: requiredDocuments,
+): {
+  requiredDocumentsList;
+} => ({
+  requiredDocumentsList: {
+    create: {
+      socialSecurityCard: randomBoolean(),
+      currentLandlordReference: randomBoolean(),
+      birthCertificate: randomBoolean(),
+      previousLandlordReference: randomBoolean(),
+      governmentIssuedId: randomBoolean(),
+      proofOfAssets: randomBoolean(),
+      proofOfIncome: randomBoolean(),
+      residencyDocuments: randomBoolean(),
+      proofOfCustody: randomBoolean(),
+      ...requiredDocumentsList,
+    },
+  },
+});
+
 export const featuresAndUtilites = (
   optionalFeatures?: optionalFeatures,
   optionalUtilities?: optionalUtilities,

api/src/decorators/validate-listing-deposit.decorator.ts

@@ -7,7 +7,7 @@ import {
   ValidatorOptions,
 } from 'class-validator';
 import Listing from '../dtos/listings/listing.dto';
-import { DepositTypeEnum } from '@prisma/client';
+import { DepositTypeEnum, ListingTypeEnum } from '@prisma/client';
 
 export function ValidateListingDeposit(validationOptions?: ValidatorOptions) {
   return function (object: object, propertyName: string) {
@@ -28,28 +28,32 @@ export class DepositValueConstraint implements ValidatorConstraintInterface {
   }
 
   validate(value: DepositTypeEnum, args: ValidationArguments) {
-    const { depositValue, depositRangeMin, depositRangeMax } =
+    const { depositValue, depositMin, depositMax, listingType } =
       args.object as Listing;
 
+    if (!listingType || listingType === ListingTypeEnum.regulated) {
+      return true;
+    }
+
     if (value === DepositTypeEnum.fixedDeposit) {
-      return (
-        !this.isFieldEmpty(depositValue) &&
-        this.isFieldEmpty(depositRangeMin) &&
-        this.isFieldEmpty(depositRangeMax)
-      );
+      return this.isFieldEmpty(depositMin) && this.isFieldEmpty(depositMax);
+    }
+    if (value === DepositTypeEnum.depositRange) {
+      return this.isFieldEmpty(depositValue);
     }
 
+    // If no Deposit type is selected then validate that it's either just depositValue or just the range values
     return (
-      this.isFieldEmpty(depositValue) &&
-      !this.isFieldEmpty(depositRangeMin) &&
-      !this.isFieldEmpty(depositRangeMax)
+      this.isFieldEmpty(depositValue) ||
+      (this.isFieldEmpty(depositMin) && this.isFieldEmpty(depositMax))
     );
   }
   defaultMessage(args?: ValidationArguments): string {
     const value = args.value as DepositTypeEnum;
+
     if (value === DepositTypeEnum.fixedDeposit) {
-      return 'When deposit is of type "fixedDeposit" the "depositValue" must be filled and the "depositRangeMin"|"depositRangeMax" fields must be null';
+      return 'When deposit is of type "fixedDeposit" the "depositValue" must be filled and the "depositMin"|"depositMax" fields must be null';
     }
-    return 'When deposit is of type "depositRange" the "depositRangeMin" and "depositRangeMax" fields must be filled and "depositValue" must be null';
+    return 'When deposit is of type "depositRange" the "depositMin" and "depositMax" fields must be filled and "depositValue" must be null';
   }
 }

api/src/decorators/validate-unit-groups-rent.decorator.ts

@@ -7,7 +7,7 @@ import {
   ValidatorConstraintInterface,
   ValidatorOptions,
 } from 'class-validator';
-import UnitGroup from 'src/dtos/unit-groups/unit-group.dto';
+import UnitGroup from '../dtos/unit-groups/unit-group.dto';
 
 export function ValidateUnitGroupRent(validationOptions?: ValidatorOptions) {
   return function (object: object, propertyName: string) {

api/src/decorators/validate-units-rent.decorator.ts

@@ -0,0 +1,58 @@
+import { RentTypeEnum } from '@prisma/client';
+import {
+  registerDecorator,
+  ValidationArguments,
+  ValidationTypes,
+  ValidatorConstraint,
+  ValidatorConstraintInterface,
+  ValidatorOptions,
+} from 'class-validator';
+import UnitGroup from '../dtos/unit-groups/unit-group.dto';
+
+export function ValidateUnitGroupRent(validationOptions?: ValidatorOptions) {
+  return function (object: object, propertyName: string) {
+    registerDecorator({
+      name: ValidationTypes.CUSTOM_VALIDATION,
+      target: object.constructor,
+      propertyName: propertyName,
+      options: validationOptions,
+      validator: RentValueConstraint,
+    });
+  };
+}
+
+@ValidatorConstraint()
+export class RentValueConstraint implements ValidatorConstraintInterface {
+  isFieldEmpty(value): boolean {
+    return value === null || value === undefined;
+  }
+
+  validate(
+    value: RentTypeEnum,
+    validationArguments?: ValidationArguments,
+  ): Promise<boolean> | boolean {
+    const { flatRentValueFrom, flatRentValueTo } =
+      validationArguments.object as UnitGroup;
+
+    if (value === RentTypeEnum.rentRange) {
+      return (
+        !this.isFieldEmpty(flatRentValueFrom) &&
+        !this.isFieldEmpty(flatRentValueTo)
+      );
+    } else {
+      return (
+        this.isFieldEmpty(flatRentValueFrom) &&
+        this.isFieldEmpty(flatRentValueTo)
+      );
+    }
+
+    return true;
+  }
+
+  defaultMessage(validationArguments?: ValidationArguments): string {
+    const rentType = validationArguments.value as RentTypeEnum;
+    if (rentType === RentTypeEnum.rentRange) {
+      return 'When rent is of type "rentRange" the "flatRentValueFrom" and "flatRentValueTo" fields must be filled';
+    }
+  }
+}

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

@@ -0,0 +1,51 @@
+import { ApiPropertyOptional } from '@nestjs/swagger';
+import { Expose } from 'class-transformer';
+import { IsBoolean } from 'class-validator';
+import { ValidationsGroupsEnum } from '../../enums/shared/validation-groups-enum';
+
+export class ListingDocuments {
+  @Expose()
+  @IsBoolean({ groups: [ValidationsGroupsEnum.default] })
+  @ApiPropertyOptional()
+  socialSecurityCard?: boolean;
+
+  @Expose()
+  @IsBoolean({ groups: [ValidationsGroupsEnum.default] })
+  @ApiPropertyOptional()
+  currentLandlordReference?: boolean;
+
+  @Expose()
+  @IsBoolean({ groups: [ValidationsGroupsEnum.default] })
+  @ApiPropertyOptional()
+  birthCertificate?: boolean;
+
+  @Expose()
+  @IsBoolean({ groups: [ValidationsGroupsEnum.default] })
+  @ApiPropertyOptional()
+  previousLandlordReference?: boolean;
+
+  @Expose()
+  @IsBoolean({ groups: [ValidationsGroupsEnum.default] })
+  @ApiPropertyOptional()
+  governmentIssuedId?: boolean;
+
+  @Expose()
+  @IsBoolean({ groups: [ValidationsGroupsEnum.default] })
+  @ApiPropertyOptional()
+  proofOfAssets?: boolean;
+
+  @Expose()
+  @IsBoolean({ groups: [ValidationsGroupsEnum.default] })
+  @ApiPropertyOptional()
+  proofOfIncome?: boolean;
+
+  @Expose()
+  @IsBoolean({ groups: [ValidationsGroupsEnum.default] })
+  @ApiPropertyOptional()
+  residencyDocuments?: boolean;
+
+  @Expose()
+  @IsBoolean({ groups: [ValidationsGroupsEnum.default] })
+  @ApiPropertyOptional()
+  proofOfCustody?: boolean;
+}

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

@@ -62,6 +62,7 @@ import {
   ValidateOnlyUnitsOrUnitGroups,
 } from '../../decorators/validate-units-required.decorator';
 import { ValidateListingDeposit } from '../../decorators/validate-listing-deposit.decorator';
+import { ListingDocuments } from './listing-documents.dto';
 
 class Listing extends AbstractDTO {
   @Expose()
@@ -398,22 +399,6 @@ class Listing extends AbstractDTO {
   @ApiPropertyOptional()
   depositValue?: number;
 
-  @Expose()
-  @ValidateListingPublish('depositRangeMin', {
-    groups: [ValidationsGroupsEnum.default],
-  })
-  @IsNumber()
-  @ApiPropertyOptional()
-  depositRangeMin?: number;
-
-  @Expose()
-  @ValidateListingPublish('depositRangeMax', {
-    groups: [ValidationsGroupsEnum.default],
-  })
-  @IsNumber()
-  @ApiPropertyOptional()
-  depositRangeMax?: number;
-
   @Expose()
   @ValidateListingPublish('depositHelperText', {
     groups: [ValidationsGroupsEnum.default],
@@ -554,6 +539,15 @@ class Listing extends AbstractDTO {
   @ApiPropertyOptional()
   requiredDocuments?: string;
 
+  @Expose()
+  @ValidateListingPublish('requiredDocumentsList', {
+    groups: [ValidationsGroupsEnum.default],
+  })
+  @Type(() => ListingDocuments)
+  @ValidateNested({ groups: [ValidationsGroupsEnum.default], each: true })
+  @ApiPropertyOptional({ type: ListingDocuments })
+  requiredDocumentsList?: ListingDocuments;
+
   @Expose()
   @ValidateListingPublish('specialNotes', {
     groups: [ValidationsGroupsEnum.default],