feat(DTFS2-7052): moving uk postcode regex to constants and doc improvements

Author: audrius-vaitonis

src/constants/geospatial.constant.ts

@@ -6,4 +6,8 @@ export const GEOSPATIAL = {
   EXAMPLES: {
     POSTCODE: 'SW1A 2AQ',
   },
+  REGEX: {
+    // UK postcode regex is from DTFS project and slightly optimised by lint.
+    UK_POSTCODE: /^[A-Za-z]{1,2}[\dRr][\dA-Za-z]?\s?\d[ABD-HJLNP-UW-Zabd-hjlnp-uw-z]{2}$/,
+  },
 };

src/modules/geospatial/dto/get-addresses-by-postcode-query.dto.ts

@@ -2,15 +2,16 @@ import { ApiProperty } from '@nestjs/swagger';
 import { GEOSPATIAL } from '@ukef/constants';
 import { Matches, MaxLength, MinLength } from 'class-validator';
 
-const UK_POSTCODE = /^[A-Za-z]{1,2}[\dRr][\dA-Za-z]?\s?\d[ABD-HJLNP-UW-Zabd-hjlnp-uw-z]{2}$/;
-
 export class GetAddressesByPostcodeQueryDto {
   @ApiProperty({
     example: GEOSPATIAL.EXAMPLES.POSTCODE,
     description: 'Postcode to search for',
+    minLength: 5,
+    maxLength: 8,
+    pattern: GEOSPATIAL.REGEX.UK_POSTCODE.source,
   })
   @MinLength(5)
   @MaxLength(8)
-  @Matches(UK_POSTCODE)
+  @Matches(GEOSPATIAL.REGEX.UK_POSTCODE)
   public postcode: string;
 }

test/docs/__snapshots__/get-docs-yaml.api-test.ts.snap

@@ -500,6 +500,10 @@ paths:
           example: SW1A 2AQ
           description: Postcode to search for
           schema:
+            minLength: 5
+            maxLength: 8
+            pattern: >-
+              ^[A-Za-z]{1,2}[\\dRr][\\dA-Za-z]?\\s?\\d[ABD-HJLNP-UW-Zabd-hjlnp-uw-z]{2}$
             type: string
       responses:
         '200':