Add ApiProperty to files that have no .dto.ts suffixes

backend/core/archer.ts

@@ -1,12 +1,9 @@
-import {
-  AmiChartCreate,
-  ApplicationMethodType,
-  CSVFormattingType,
-  Listing,
-  ListingStatus,
-} from "./types"
+import { AmiChart, ApplicationMethodType, CSVFormattingType, Listing, ListingStatus } from "./types"
 
-export const SanMateoHUD2019: AmiChartCreate = {
+export const SanMateoHUD2019: AmiChart = {
+  id: "ami_chart_id",
+  createdAt: new Date(),
+  updatedAt: new Date(),
   name: "SanMateoHUD2019",
   items: [
     {
@@ -255,6 +252,9 @@ export const ArcherListing: Listing = {
   status: ListingStatus.active,
   postmarkedApplicationsReceivedByDate: new Date("2019-12-05"),
   applicationAddress: {
+    id: "id",
+    createdAt: new Date(),
+    updatedAt: new Date(),
     city: "San Jose",
     street: "98 Archer Street",
     zipCode: "95112",
@@ -333,6 +333,9 @@ export const ArcherListing: Listing = {
     "A criminal background investigation will be obtained on each applicant.  As criminal background checks are done county by county and will be ran for all counties in which the applicant lived,  Applicants will be disqualified for tenancy if they have been convicted of a felony or misdemeanor.  Refer to Tenant Selection Criteria or Qualification Criteria for details related to the qualification process. ",
   CSVFormattingType: CSVFormattingType.basic,
   leasingAgentAddress: {
+    id: "id",
+    createdAt: new Date(),
+    updatedAt: new Date(),
     city: "San Jose",
     street: "98 Archer Street",
     zipCode: "95112",

backend/core/nest-cli.json

@@ -3,11 +3,15 @@
   "sourceRoot": "src",
   "compilerOptions": {
     "plugins": [
-      "@nestjs/swagger/plugin"
-    ],
-    "dtoFileNameSuffix": [
-      "dto.ts",
-      "entity.ts"
+      {
+        "name": "@nestjs/swagger",
+        "options": {
+          "dtoFileNameSuffix": ["dto.ts", "entity.ts"],
+          "controllerFileNameSuffix": ["controller.ts"],
+          "classValidatorShim": false,
+          "introspectComments": true
+        }
+      }
     ],
     "assets": [
       { "include": "auth/*.{conf,csv}", "outDir": "dist/src" },

backend/core/package.json

@@ -38,7 +38,7 @@
     "@nestjs/jwt": "^7.1.0",
     "@nestjs/passport": "^7.1.0",
     "@nestjs/platform-express": "^7.4.4",
-    "@nestjs/swagger": "4.6.1",
+    "@nestjs/swagger": "4.8.0",
     "@nestjs/throttler": "^1.1.2",
     "@nestjs/typeorm": "^7.1.0",
     "@types/cache-manager": "^3.4.0",

backend/core/src/applications/types/application-preference-option.ts

@@ -19,15 +19,18 @@ export class ApplicationPreferenceOption {
   @Expose()
   @IsString({ groups: [ValidationsGroupsEnum.default] })
   @MaxLength(128, { groups: [ValidationsGroupsEnum.default] })
+  @ApiProperty()
   key: string
 
   @Expose()
   @IsBoolean({ groups: [ValidationsGroupsEnum.default] })
+  @ApiProperty()
   checked: boolean
 
   @Expose()
   @ApiProperty({
     type: "array",
+    required: false,
     items: {
       oneOf: [
         { $ref: getSchemaPath(BooleanInput) },

backend/core/src/applications/types/form-metadata/address-input.ts

@@ -3,11 +3,13 @@ import { Expose, Type } from "class-transformer"
 import { IsDefined, ValidateNested } from "class-validator"
 import { ValidationsGroupsEnum } from "../../../shared/types/validations-groups-enum"
 import { AddressCreateDto } from "../../../shared/dto/address.dto"
+import { ApiProperty } from "@nestjs/swagger"
 
 export class AddressInput extends FormMetadataExtraData {
   @Expose()
   @IsDefined({ groups: [ValidationsGroupsEnum.default] })
   @ValidateNested({ groups: [ValidationsGroupsEnum.default] })
   @Type(() => AddressCreateDto)
+  @ApiProperty()
   value: AddressCreateDto
 }

backend/core/src/applications/types/form-metadata/boolean-input.ts

@@ -2,9 +2,11 @@ import { FormMetadataExtraData } from "./form-metadata-extra-data"
 import { Expose } from "class-transformer"
 import { IsBoolean } from "class-validator"
 import { ValidationsGroupsEnum } from "../../../shared/types/validations-groups-enum"
+import { ApiProperty } from "@nestjs/swagger"
 
 export class BooleanInput extends FormMetadataExtraData {
   @Expose()
   @IsBoolean({ groups: [ValidationsGroupsEnum.default] })
+  @ApiProperty()
   value: boolean
 }

backend/core/src/applications/types/form-metadata/form-metadata-extra-data.ts

@@ -14,5 +14,6 @@ export class FormMetadataExtraData {
   @Expose()
   @IsString({ groups: [ValidationsGroupsEnum.default] })
   @MaxLength(128, { groups: [ValidationsGroupsEnum.default] })
+  @ApiProperty()
   key: string
 }

backend/core/src/applications/types/form-metadata/form-metadata-options.ts

@@ -2,17 +2,20 @@ import { Expose, Type } from "class-transformer"
 import { ArrayMaxSize, IsOptional, IsString, MaxLength, ValidateNested } from "class-validator"
 import { ValidationsGroupsEnum } from "../../../shared/types/validations-groups-enum"
 import { FormMetadataExtraData } from "./form-metadata-extra-data"
+import { ApiProperty } from "@nestjs/swagger"
 
 export class FormMetadataOptions {
   @Expose()
   @IsString({ groups: [ValidationsGroupsEnum.default] })
   @MaxLength(128, { groups: [ValidationsGroupsEnum.default] })
+  @ApiProperty()
   key: string
 
   @Expose()
   @IsOptional({ groups: [ValidationsGroupsEnum.default] })
   @ArrayMaxSize(64, { groups: [ValidationsGroupsEnum.default] })
   @ValidateNested({ groups: [ValidationsGroupsEnum.default], each: true })
   @Type(() => FormMetadataExtraData)
-  extraData?: FormMetadataExtraData[]
+  @ApiProperty({ type: [FormMetadataExtraData], required: false })
+  extraData?: FormMetadataExtraData[] | null
 }

backend/core/src/applications/types/form-metadtaa/form-metadata.ts → backend/core/src/applications/types/form-metadata/form-metadata.ts

@@ -1,17 +1,20 @@
 import { Expose, Type } from "class-transformer"
 import { ArrayMaxSize, IsString, MaxLength, ValidateNested } from "class-validator"
 import { ValidationsGroupsEnum } from "../../../shared/types/validations-groups-enum"
-import { FormMetadataOptions } from "../form-metadata/form-metadata-options"
+import { FormMetadataOptions } from "./form-metadata-options"
+import { ApiProperty } from "@nestjs/swagger"
 
 export class FormMetadata {
   @Expose()
   @IsString({ groups: [ValidationsGroupsEnum.default] })
   @MaxLength(128, { groups: [ValidationsGroupsEnum.default] })
+  @ApiProperty()
   key: string
 
   @Expose()
   @ArrayMaxSize(64, { groups: [ValidationsGroupsEnum.default] })
   @ValidateNested({ groups: [ValidationsGroupsEnum.default], each: true })
   @Type(() => FormMetadataOptions)
+  @ApiProperty({ type: [FormMetadataOptions], nullable: true })
   options: FormMetadataOptions[]
 }

backend/core/src/applications/types/form-metadata/text-input.ts

@@ -2,10 +2,12 @@ import { FormMetadataExtraData } from "./form-metadata-extra-data"
 import { Expose } from "class-transformer"
 import { IsString, MaxLength } from "class-validator"
 import { ValidationsGroupsEnum } from "../../../shared/types/validations-groups-enum"
+import { ApiProperty } from "@nestjs/swagger"
 
 export class TextInput extends FormMetadataExtraData {
   @Expose()
   @IsString({ groups: [ValidationsGroupsEnum.default] })
   @MaxLength(4096, { groups: [ValidationsGroupsEnum.default] })
+  @ApiProperty()
   value: string
 }

backend/core/src/listings/dto/listing.dto.ts

@@ -45,7 +45,7 @@ export class ListingDto extends OmitType(Listing, [
   @Expose()
   @IsOptional({ groups: [ValidationsGroupsEnum.default] })
   @ValidateNested({ groups: [ValidationsGroupsEnum.default] })
-  @Type(() => AddressCreateDto)
+  @Type(() => AddressDto)
   applicationPickUpAddress: AddressDto | null
 
   @Expose()

backend/core/src/listings/entities/listing.entity.ts

@@ -316,7 +316,7 @@ class Listing extends BaseEntity {
     nullable: false,
   })
   @Expose()
-  @ApiProperty({ type: Boolean, default: false })
+  @ApiProperty()
   @IsBoolean()
   displayWaitlistSize: boolean
 

backend/core/src/preferences/entities/preference.entity.ts

@@ -10,8 +10,9 @@ import { Listing } from "../../listings/entities/listing.entity"
 import { Expose, Type } from "class-transformer"
 import { IsDate, IsNumber, IsOptional, IsString, IsUUID, ValidateNested } from "class-validator"
 import { ValidationsGroupsEnum } from "../../shared/types/validations-groups-enum"
-import { FormMetadata } from "../../applications/types/form-metadtaa/form-metadata"
+import { FormMetadata } from "../../applications/types/form-metadata/form-metadata"
 import { PreferenceLink } from "../types/preference-link"
+import { ApiProperty } from "@nestjs/swagger"
 
 @Entity({ name: "preferences" })
 class Preference {
@@ -62,6 +63,7 @@ class Preference {
   @IsOptional({ groups: [ValidationsGroupsEnum.default] })
   @ValidateNested({ groups: [ValidationsGroupsEnum.default], each: true })
   @Type(() => PreferenceLink)
+  @ApiProperty({type: [PreferenceLink]})
   links: PreferenceLink[] | null
 
   @ManyToOne(() => Listing, (listing) => listing.preferences, {

backend/core/src/preferences/types/preference-link.ts

@@ -1,12 +1,16 @@
 import { Expose } from "class-transformer"
 import { IsString } from "class-validator"
 import { ValidationsGroupsEnum } from "../../shared/types/validations-groups-enum"
+import { ApiProperty } from "@nestjs/swagger"
 
 export class PreferenceLink {
   @Expose()
   @IsString({ groups: [ValidationsGroupsEnum.default] })
+  @ApiProperty()
   title: string
+
   @Expose()
   @IsString({ groups: [ValidationsGroupsEnum.default] })
+  @ApiProperty()
   url: string
 }

backend/core/src/property/entities/property.entity.ts

@@ -138,7 +138,7 @@ export class Property {
   yearBuilt: number | null
 
   @Expose()
-  @ApiProperty()
+  @ApiProperty({ type: UnitsSummarized })
   get unitsSummarized(): UnitsSummarized | undefined {
     if (Array.isArray(this.units) && this.units.length > 0) {
       return transformUnits(this.units)

backend/core/src/units/types/hmi.ts

@@ -1,6 +1,10 @@
 import { AnyDict } from "../../shared/units-transformations"
+import { ApiProperty } from "@nestjs/swagger"
 
 export class HMI {
+  @ApiProperty()
   columns: AnyDict
+
+  @ApiProperty({type: [Object]})
   rows: AnyDict[]
 }

backend/core/src/units/types/min-max-currency.ts

@@ -1,15 +1,18 @@
 import { Expose } from "class-transformer"
 import { IsDefined, IsString } from "class-validator"
 import { ValidationsGroupsEnum } from "../../shared/types/validations-groups-enum"
+import { ApiProperty } from "@nestjs/swagger"
 
 export class MinMaxCurrency {
   @Expose()
   @IsDefined({ groups: [ValidationsGroupsEnum.default] })
   @IsString({ groups: [ValidationsGroupsEnum.default] })
+  @ApiProperty()
   min: string
 
   @Expose()
   @IsDefined({ groups: [ValidationsGroupsEnum.default] })
   @IsString({ groups: [ValidationsGroupsEnum.default] })
+  @ApiProperty()
   max: string
 }

backend/core/src/units/types/min-max.ts

@@ -1,15 +1,18 @@
 import { Expose } from "class-transformer"
 import { IsDefined, IsNumber } from "class-validator"
 import { ValidationsGroupsEnum } from "../../shared/types/validations-groups-enum"
+import { ApiProperty } from "@nestjs/swagger"
 
 export class MinMax {
   @Expose()
   @IsDefined({ groups: [ValidationsGroupsEnum.default] })
   @IsNumber({}, { groups: [ValidationsGroupsEnum.default] })
+  @ApiProperty()
   min: number
 
   @Expose()
   @IsDefined({ groups: [ValidationsGroupsEnum.default] })
   @IsNumber({}, { groups: [ValidationsGroupsEnum.default] })
+  @ApiProperty()
   max: number
 }

backend/core/src/units/types/unit-summary-by-ami.ts

@@ -3,22 +3,26 @@ import { IsDefined, IsString, ValidateNested } from "class-validator"
 import { ValidationsGroupsEnum } from "../../shared/types/validations-groups-enum"
 import { UnitSummary } from "./unit-summary"
 import { UnitSummaryByReservedType } from "./unit-summary-by-reserved-type"
+import { ApiProperty } from "@nestjs/swagger"
 
 export class UnitSummaryByAMI {
   @Expose()
   @IsDefined({ groups: [ValidationsGroupsEnum.default] })
   @IsString({ groups: [ValidationsGroupsEnum.default] })
+  @ApiProperty()
   percent: string
 
   @Expose()
   @IsDefined({ groups: [ValidationsGroupsEnum.default] })
   @ValidateNested({ groups: [ValidationsGroupsEnum.default], each: true })
   @Type(() => UnitSummary)
+  @ApiProperty({ type: [UnitSummary] })
   byNonReservedUnitType: UnitSummary[]
 
   @Expose()
   @IsDefined({ groups: [ValidationsGroupsEnum.default] })
   @ValidateNested({ groups: [ValidationsGroupsEnum.default], each: true })
   @Type(() => UnitSummaryByReservedType)
+  @ApiProperty({ type: [UnitSummaryByReservedType] })
   byReservedType: UnitSummaryByReservedType[]
 }

backend/core/src/units/types/unit-summary-by-reserved-type.ts

@@ -2,16 +2,19 @@ import { Expose, Type } from "class-transformer"
 import { IsDefined, IsString, ValidateNested } from "class-validator"
 import { ValidationsGroupsEnum } from "../../shared/types/validations-groups-enum"
 import { UnitSummary } from "./unit-summary"
+import { ApiProperty } from "@nestjs/swagger"
 
 export class UnitSummaryByReservedType {
   @Expose()
   @IsDefined({ groups: [ValidationsGroupsEnum.default] })
   @IsString({ groups: [ValidationsGroupsEnum.default] })
+  @ApiProperty()
   reservedType: string
 
   @Expose()
   @IsDefined({ groups: [ValidationsGroupsEnum.default] })
   @ValidateNested({ groups: [ValidationsGroupsEnum.default], each: true })
   @Type(() => UnitSummary)
+  @ApiProperty({ type: [UnitSummary] })
   byUnitType: UnitSummary[]
 }