chore(APIM-612): companies house - isactive field

src/constants/companies.constant.ts

@@ -7,4 +7,7 @@ export const COMPANIES = {
     // This Companies House registration number regex was copied from the DTFS codebase.
     COMPANIES_HOUSE_REGISTRATION_NUMBER: /^(([A-Z]{2}|[A-Z]\d|\d{2})(\d{6}|\d{5}[A-Z]))$/,
   },
+  STATUS: {
+    ACTIVE: 'active',
+  },
 };

src/modules/companies/companies.service.ts

@@ -1,4 +1,5 @@
 import { Injectable, NotFoundException, UnprocessableEntityException } from '@nestjs/common';
+import { COMPANIES } from '@ukef/constants';
 import { CompaniesHouseService } from '@ukef/helper-modules/companies-house/companies-house.service';
 import { GetCompanyCompaniesHouseResponse } from '@ukef/helper-modules/companies-house/dto/get-company-companies-house-response.dto';
 import { CompaniesHouseNotFoundException } from '@ukef/helper-modules/companies-house/exception/companies-house-not-found.exception';
@@ -84,6 +85,7 @@ export class CompaniesService {
         region: address?.region,
       },
       industries: this.mapSicCodes(company.sic_codes, industryClasses),
+      isActive: company?.company_status === COMPANIES.STATUS.ACTIVE,
     };
   }
 

src/modules/companies/dto/get-company-response.dto.ts

@@ -46,6 +46,7 @@ export class GetCompanyResponse {
   dateOfCreation: string;
   registeredAddress: RegisteredAddress;
   industries: Industry[];
+  isActive: boolean;
 }
 
 export class Industry {

test/support/generator/get-company-generator.ts

@@ -62,6 +62,7 @@
       ],
       industrySectorCode: this.valueGenerator.integer({ min: 1001, max: 1020 }),
       industrySectorName: this.valueGenerator.sentence({ words: 4 }),
+      isActive: this.valueGenerator.boolean(),
     };
   }
 
@@ -78,7 +79,7 @@
     const shuffleArray = <T>(array: Array<T>) => {
       for (const i of [...Array(array.length).keys()].reverse().slice(0, -1)) {
         const j = Math.floor(Math.random() * (i + 1));
         [array[i], array[j]] = [array[j], array[i]];
       }
     };
 
@@ -150,7 +151,7 @@
       ukefSectorName: v.industrySectorName,
       internalNo: null,
       ukefIndustryId: sicCode,
       ukefIndustryName: v.industryClassNames[index],
       acbsSectorId: this.valueGenerator.stringOfNumericCharacters({ length: 2 }),
       acbsSectorName: this.valueGenerator.sentence({ words: 5 }),
       acbsIndustryId: this.valueGenerator.stringOfNumericCharacters({ length: 2 }),
@@ -228,6 +229,7 @@
         country: v.country,
       },
       industries,
+      isActive: v.isActive,
     };
 
     const getCompanyCompaniesHouseOverseasCompanyResponse = structuredClone(getCompanyCompaniesHouseResponse);
@@ -297,6 +299,7 @@
   industryClassNames: string[];
   industrySectorCode: number;
   industrySectorName: string;
+  isActive: boolean;
 }
 
 interface GenerateOptions {