Merge branch 'master' into feature/faml-746-psc-discrepancies

Author: CH-JonathanBlake

src/client.ts

@@ -11,7 +11,7 @@ import AlphabeticalSearchService from "./services/search/alphabetical-search/ser
 import DissolvedSearchService from "./services/search/dissolved-search/service";
 import PSCDiscrepancyService from "./services/psc-discrepancies/service";
 import PSCDiscrepancyReportService from "./services/psc-discrepancies-report/service";
-import { PSCDiscrepanciesReportService } from "services/psc-discrepancies-report";
+import { PSCDiscrepanciesReportService } from "./services/psc-discrepancies-report";
 
 /**
  * ApiClient is the class that all service objects hang off.

src/services/psc-discrepancies-report/service.ts

@@ -1,8 +1,8 @@
 import { IHttpClient } from "../../http";
 import { PSCDiscrepancyReport } from "./types"
 import Util from "./util"
-import { Result } from "services/result";
-import { ApiResponse, ApiErrorResponse } from "services/resource";
+import { Result } from "../../services/result";
+import { ApiResponse, ApiErrorResponse } from "../../services/resource";
 
 const PSC_DISCREPANCY_API_URL = "/psc-discrepancy-reports";
 

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

@@ -1,30 +1,42 @@
 import { IHttpClient } from "../../../http";
 import { CompaniesResource } from "./types";
 import Resource from "../../resource";
+import { start } from "repl";
 
 export default class DissolvedSearchService {
     constructor (private readonly client: IHttpClient) { }
-    public async getCompanies (companyName: string, requestId: string, searchType: string): Promise<Resource<CompaniesResource>> {
+    public async getCompanies (companyName: string, requestId: string, searchType: string, startIndex: number): Promise<Resource<CompaniesResource>> {
         const additionalHeaders = {
             "X-Request-ID": requestId,
             "Content-Type": "application/json"
         }
         const ALPHABETICAL_QUERY = "&search_type=alphabetical";
         const BEST_MATCH_QUERY = "&search_type=best-match";
         const PREVIOUS_NAME_QUERY = "&search_type=previous-name-dissolved";
+        const START_INDEX_QUERY = "&start_index=" + startIndex;
 
         let dissolvedSearchURL = "/dissolved-search/companies?q=" + companyName;
 
         if (searchType === "alphabetical") {
             dissolvedSearchURL += ALPHABETICAL_QUERY;
         }
-        if (searchType === "previousNameDissolved") {
+
+        if (!startIndex && searchType === "previousNameDissolved") {
             dissolvedSearchURL += PREVIOUS_NAME_QUERY;
         }
-        if (searchType === "bestMatch") {
+
+        if (startIndex && searchType === "previousNameDissolved") {
+            dissolvedSearchURL += PREVIOUS_NAME_QUERY + START_INDEX_QUERY;
+        }
+
+        if (!startIndex && searchType === "bestMatch") {
             dissolvedSearchURL += BEST_MATCH_QUERY;
         }
 
+        if (startIndex && searchType === "bestMatch") {
+            dissolvedSearchURL += BEST_MATCH_QUERY + START_INDEX_QUERY;
+        }
+
         const resp = await this.client.httpGet(dissolvedSearchURL, additionalHeaders);
 
         const resource: Resource<CompaniesResource> = {

src/services/search/dissolved-search/types.ts

@@ -3,6 +3,7 @@ export interface CompaniesResource {
     items: Items[];
     kind: string;
     top_hit: TopHit;
+    hits: number;
 }
 
 export interface Items {

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

@@ -51,12 +51,14 @@ const mockResponseBody : CompaniesResource = ({
                 name: "old name"
             }
         ]
-    }
+    },
+    hits: 20
 });
 
 const mockRequestId = "fdskfhsdoifhsffsif";
 const testCompanyName = "TEST COMPANY NAME";
 const searchType = "alphabetical";
+const startIndex = 0;
 
 describe("create a dissolved search GET", () => {
     beforeEach(() => {
@@ -78,7 +80,7 @@ describe("create a dissolved search GET", () => {
 
         const mockRequest = sinon.stub(requestClient, "httpGet").resolves(mockGetRequest);
         const search: DissolvedSearchService = new DissolvedSearchService(requestClient);
-        const data: Resource<CompaniesResource> = await search.getCompanies(testCompanyName, mockRequestId, searchType);
+        const data: Resource<CompaniesResource> = await search.getCompanies(testCompanyName, mockRequestId, searchType, startIndex);
 
         expect(data.httpStatusCode).to.equal(401);
         expect(data.resource).to.be.undefined;
@@ -92,7 +94,7 @@ describe("create a dissolved search GET", () => {
 
         const mockRequest = sinon.stub(requestClient, "httpGet").resolves(mockGetRequest);
         const search: DissolvedSearchService = new DissolvedSearchService(requestClient);
-        const data: Resource<CompaniesResource> = await search.getCompanies(testCompanyName, mockRequestId, searchType);
+        const data: Resource<CompaniesResource> = await search.getCompanies(testCompanyName, mockRequestId, searchType, startIndex);
         const item = data.resource.items[0];
         const mockItem = mockResponseBody.items[0];
 
@@ -121,5 +123,6 @@ describe("create a dissolved search GET", () => {
         expect(data.resource.top_hit.previous_company_names[0].ceased_on).to.equal(mockResponseBody.top_hit.previous_company_names[0].ceased_on);
         expect(data.resource.top_hit.previous_company_names[0].effective_from).to.equal(mockResponseBody.top_hit.previous_company_names[0].effective_from);
         expect(data.resource.top_hit.previous_company_names[0].name).to.equal(mockResponseBody.top_hit.previous_company_names[0].name);
+        expect(data.resource.hits).to.equal(mockResponseBody.hits);
     });
 });