Merge pull request #287 from companieshouse/add-start-index-advanced

BI-9341 - Add start index paramater to sdk to enable paging

Author: caismith-ch

src/services/search/advanced-search/service.ts

@@ -5,9 +5,10 @@ import "url-search-params-polyfill";
 
 export default class AdvancedSearchService {
     constructor (private readonly client: IHttpClient) { }
-    public async getCompanies (companyNameIncludes: string | null, companyNameExcludes: string | null, location: string | null, incorporatedFrom: string | null,
+    public async getCompanies (startIndex: number | null, companyNameIncludes: string | null, companyNameExcludes: string | null, location: string | null, incorporatedFrom: string | null,
         incorporatedTo: string | null, sicCodes: string | null, companyStatus: string | null, companyType: string | null, dissolvedFrom: string | null,
         dissolvedTo: string | null, requestId: string): Promise<Resource<CompaniesResource>> {
+        const START_INDEX_QUERY = "start_index";
         const COMPANY_NAME_INCLUDES_QUERY = "company_name_includes";
         const COMPANY_NAME_EXCLUDES_QUERY = "company_name_excludes"
         const LOCATION_QUERY = "location";
@@ -25,6 +26,10 @@ export default class AdvancedSearchService {
 
         const buildEnhancedSearchURL = new URLSearchParams("/enhanced-search/companies?");
 
+        if (startIndex !== null) {
+            buildEnhancedSearchURL.append(START_INDEX_QUERY, String(startIndex));
+        }
+
         if (companyNameIncludes !== null) {
             buildEnhancedSearchURL.append(COMPANY_NAME_INCLUDES_QUERY, companyNameIncludes)
         }

test/services/search/advanced-search/service.spec.ts

@@ -67,6 +67,7 @@ const mockResponseBody : CompaniesResource = ({
 })
 
 const mockRequestId = "fdskfhsdoifhsffsif";
+const testStartIndex = 0;
 const testCompanyNameIncludes = "INCLUDES";
 const testCompanyNameExcludes = "EXCLUDES"
 const testLocation = "TEST LOCATION";
@@ -99,7 +100,7 @@ describe("create an advanced search GET", () => {
 
         const mockRequest = sinon.stub(requestClient, "httpGet").resolves(mockGetRequest);
         const search: AdvancedSearchService = new AdvancedSearchService(requestClient);
-        const data: Resource<CompaniesResource> = await search.getCompanies(testCompanyNameIncludes, testCompanyNameExcludes, testLocation, testIncorporatedFrom,
+        const data: Resource<CompaniesResource> = await search.getCompanies(testStartIndex, testCompanyNameIncludes, testCompanyNameExcludes, testLocation, testIncorporatedFrom,
             testIncorporatedTo, testSicCodes, testCompanyStatus, testCompanyType, testDissolvedFrom, testDissolvedTo, mockRequestId);
 
         expect(data.httpStatusCode).to.equal(401);
@@ -114,7 +115,7 @@ describe("create an advanced search GET", () => {
 
         const mockRequest = sinon.stub(requestClient, "httpGet").resolves(mockGetRequest);
         const search: AdvancedSearchService = new AdvancedSearchService(requestClient);
-        const data: Resource<CompaniesResource> = await search.getCompanies(testCompanyNameIncludes, testCompanyNameExcludes, testLocation, testIncorporatedFrom,
+        const data: Resource<CompaniesResource> = await search.getCompanies(testStartIndex, testCompanyNameIncludes, testCompanyNameExcludes, testLocation, testIncorporatedFrom,
             testIncorporatedTo, testSicCodes, testCompanyStatus, testCompanyNameIncludes, testDissolvedFrom, testDissolvedTo, mockRequestId);
         const item = data.resource.items[0];
         const mockItem = mockResponseBody.items[0];