Merge pull request #34 from bcgov/feat/update-post-length-limits

Update length limits

src/common/constants/parameter-constants.ts

@@ -6,7 +6,8 @@ const uniformResponseParamName = 'uniformresponse';
 const recordCountHeaderName = 'total-record-count';
 const sinceParamName = 'since';
 
-const idRegex = /[0-9\-A-Za-z]+/;
+const idMaxLength = 100;
+const idRegex = /^[0-9\-A-Za-z]{1,100}$/;
 const idName = 'rowId';
 
 const casesAttachmentsFieldName = 'No Intervention';
@@ -22,6 +23,7 @@ export {
   uniformResponseParamName,
   recordCountHeaderName,
   sinceParamName,
+  idMaxLength,
   idRegex,
   idName,
   casesAttachmentsFieldName,

src/common/constants/upstream-constants.ts

@@ -16,6 +16,8 @@ const pageSizeMax = 100;
 const pageSizeDefault = 10;
 const startRowNumMin = 0;
 const startRowNumDefault = 0;
+const visitDetailsMax = 100;
+const visitDescriptionMax = 4000;
 
 export {
   baseUrlEnvVarName,
@@ -36,4 +38,6 @@ export {
   pageSizeDefault,
   startRowNumMin,
   startRowNumDefault,
+  visitDetailsMax,
+  visitDescriptionMax,
 };

src/dto/filter-query-params.dto.ts

@@ -1,5 +1,5 @@
 import { ApiProperty } from '@nestjs/swagger';
-import { Expose } from 'class-transformer';
+import { Exclude, Expose } from 'class-transformer';
 import {
   IsEnum,
   IsInt,
@@ -21,6 +21,7 @@ import {
 } from '../common/constants/upstream-constants';
 import { sinceParamName } from '../common/constants/parameter-constants';
 
+@Exclude()
 export class FilterQueryParams {
   @IsOptional()
   @IsISO8601({ strict: true })

src/dto/id-path-params.dto.ts

@@ -1,12 +1,18 @@
 import { ApiProperty } from '@nestjs/swagger';
 import { Matches } from 'class-validator';
-import { idName, idRegex } from '../common/constants/parameter-constants';
+import {
+  idMaxLength,
+  idName,
+  idRegex,
+} from '../common/constants/parameter-constants';
 
 export class IdPathParams {
   @Matches(idRegex)
   @ApiProperty({
     example: 'Entity-Id-Here',
     description: 'The Entity Id for your selected record type.',
+    maxLength: idMaxLength,
+    pattern: idRegex.toString().replaceAll('/', ''),
   })
   [idName]: string;
 }

src/dto/post-in-person-visit.dto.ts

@@ -1,14 +1,17 @@
-import { Expose, Transform } from 'class-transformer';
+import { Exclude, Expose, Transform } from 'class-transformer';
 import { isPastISO8601Date } from '../helpers/utilities/utilities.service';
 import { ApiProperty, ApiSchema } from '@nestjs/swagger';
-import { IsEnum, IsNotEmpty } from 'class-validator';
+import { IsEnum, IsNotEmpty, MaxLength } from 'class-validator';
 import { VisitDetails } from '../common/constants/enumerations';
 import {
   childVisitEntityIdFieldName,
   childVisitIdirFieldName,
   childVisitType,
+  visitDescriptionMax,
+  visitDetailsMax,
 } from '../common/constants/upstream-constants';
 
+@Exclude()
 @ApiSchema({ name: 'PostInPersonVisitRequest' })
 export class PostInPersonVisitDto {
   @Transform(({ value }) => {
@@ -24,21 +27,24 @@ export class PostInPersonVisitDto {
   })
   'Date of visit': string;
 
-  // TODO: limit string length once given info about limits
   @IsNotEmpty()
+  @MaxLength(visitDescriptionMax)
   @Expose()
   @ApiProperty({
     example: 'Comments here',
     description: 'Visit comments',
+    maxLength: visitDescriptionMax,
   })
   'Visit Description': string;
 
   @IsEnum(VisitDetails)
+  @MaxLength(visitDetailsMax)
   @Expose()
   @ApiProperty({
     example: VisitDetails.PrivateVisitInHome,
     description: 'The visit type',
     enum: VisitDetails,
+    maxLength: visitDetailsMax,
   })
   'Visit Details Value': string;
 }