@studyportals/search-api-interface 3.0.0 → 3.1.0

package/index.d.ts

@@ -25,4 +25,10 @@ import { IScholarshipSearchCountResponse } from "./src/scholarships/IScholarship
 import { ScholarshipFormat } from "./src/scholarships/ScholarshipFormatEnum";
 import { ScholarshipType } from "./src/scholarships/ScholarshipTypeEnum";
 import { SearchApiScholarshipClient } from "./src/scholarships/SearchApiScholarshipsClient";
-export { SearchApiOrganisationClient, IOrganisationSearchResponse, IOrganisationSearchFilters, OrganisationSearchFilters, SearchApiProgrammeClient, IProgrammeSearchResponse, IProgrammeSearchFilters, ProgrammeSearchFilters, OrganisationSearchInput, ProgrammeSearchInput, IProgrammeResult, DegreeTypeEnum, DeliveryMethodEnum, HitsTotalRelation, ProgrammeSortType, FacetResponseType, FacetValues, TextSearchAlgorithmType, ProgrammeFilterType, ISuggestionResult, SearchApiScholarshipClient, IScholarshipSearchResponse, IScholarshipSearchFilters, ScholarshipSearchFilters, ScholarshipSearchInput, IScholarshipSearchCountResponse, ScholarshipFormat, ScholarshipType };
+import { SearchApiCityClient } from "./src/cities/SearchApiCityClient";
+import { CitySearchInput } from "./src/cities/CitySearchInput";
+import { CitySearchFilters } from "./src/cities/CitySearchFilters";
+import { ICitySearchFilters } from "./src/cities/ICitySearchFilters";
+import { ICitySearchResponse } from "./src/cities/ICitySearchResponse";
+import { ICity } from "./src/cities/ICity";
+export { SearchApiOrganisationClient, IOrganisationSearchResponse, IOrganisationSearchFilters, OrganisationSearchFilters, SearchApiProgrammeClient, IProgrammeSearchResponse, IProgrammeSearchFilters, ProgrammeSearchFilters, OrganisationSearchInput, ProgrammeSearchInput, IProgrammeResult, DegreeTypeEnum, DeliveryMethodEnum, HitsTotalRelation, ProgrammeSortType, FacetResponseType, FacetValues, TextSearchAlgorithmType, ProgrammeFilterType, ISuggestionResult, SearchApiScholarshipClient, IScholarshipSearchResponse, IScholarshipSearchFilters, ScholarshipSearchFilters, ScholarshipSearchInput, IScholarshipSearchCountResponse, ScholarshipFormat, ScholarshipType, SearchApiCityClient, ICitySearchResponse, ICitySearchFilters, CitySearchFilters, CitySearchInput, ICity };

package/index.js

@@ -15,5 +15,7 @@ import { ScholarshipSearchFilters } from "./src/scholarships/ScholarshipSearchFi
 import { ScholarshipFormat } from "./src/scholarships/ScholarshipFormatEnum";
 import { ScholarshipType } from "./src/scholarships/ScholarshipTypeEnum";
 import { SearchApiScholarshipClient } from "./src/scholarships/SearchApiScholarshipsClient";
-export { SearchApiOrganisationClient, IOrganisationSearchFilters, OrganisationSearchFilters, SearchApiProgrammeClient, IProgrammeSearchFilters, ProgrammeSearchFilters, IProgrammeResult, DegreeTypeEnum, DeliveryMethodEnum, HitsTotalRelation, ProgrammeSortType, TextSearchAlgorithmType, ProgrammeFilterType, SearchApiScholarshipClient, ScholarshipSearchFilters, ScholarshipFormat, ScholarshipType };
+import { SearchApiCityClient } from "./src/cities/SearchApiCityClient";
+import { CitySearchFilters } from "./src/cities/CitySearchFilters";
+export { SearchApiOrganisationClient, IOrganisationSearchFilters, OrganisationSearchFilters, SearchApiProgrammeClient, IProgrammeSearchFilters, ProgrammeSearchFilters, IProgrammeResult, DegreeTypeEnum, DeliveryMethodEnum, HitsTotalRelation, ProgrammeSortType, TextSearchAlgorithmType, ProgrammeFilterType, SearchApiScholarshipClient, ScholarshipSearchFilters, ScholarshipFormat, ScholarshipType, SearchApiCityClient, CitySearchFilters };
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAE,0BAA0B,EAAE,MAAM,gDAAgD,CAAC;AAE5F,OAAO,EAAE,yBAAyB,EAAE,MAAM,+CAA+C,CAAC;AAE1F,OAAO,EAAE,2BAA2B,EAAE,MAAM,iDAAiD,CAAC;AAC9F,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AACrE,OAAO,EAAE,uBAAuB,EAAE,MAAM,0CAA0C,CAAC;AAEnF,OAAO,EAAE,sBAAsB,EAAE,MAAM,yCAAyC,CAAC;AAEjF,OAAO,EAAE,wBAAwB,EAAE,MAAM,2CAA2C,CAAC;AAErF,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AACvE,OAAO,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,sCAAsC,CAAC;AAI3E,OAAO,EAAE,wBAAwB,EAAE,MAAM,6CAA6C,CAAC;AAGvF,OAAO,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAC;AAC7E,OAAO,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAC;AACzE,OAAO,EAAE,0BAA0B,EAAE,MAAM,gDAAgD,CAAC;AAE5F,OAAO,EACN,2BAA2B,EAE3B,0BAA0B,EAC1B,yBAAyB,EAEzB,wBAAwB,EAExB,uBAAuB,EACvB,sBAAsB,EAItB,gBAAgB,EAEhB,cAAc,EACd,kBAAkB,EAClB,iBAAiB,EAEjB,iBAAiB,EAKjB,uBAAuB,EACvB,mBAAmB,EAInB,0BAA0B,EAG1B,wBAAwB,EAGxB,iBAAiB,EACjB,eAAe,EACf,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAE,0BAA0B,EAAE,MAAM,gDAAgD,CAAC;AAE5F,OAAO,EAAE,yBAAyB,EAAE,MAAM,+CAA+C,CAAC;AAE1F,OAAO,EAAE,2BAA2B,EAAE,MAAM,iDAAiD,CAAC;AAC9F,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AACrE,OAAO,EAAE,uBAAuB,EAAE,MAAM,0CAA0C,CAAC;AAEnF,OAAO,EAAE,sBAAsB,EAAE,MAAM,yCAAyC,CAAC;AAEjF,OAAO,EAAE,wBAAwB,EAAE,MAAM,2CAA2C,CAAC;AAErF,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AACvE,OAAO,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,sCAAsC,CAAC;AAI3E,OAAO,EAAE,wBAAwB,EAAE,MAAM,6CAA6C,CAAC;AAGvF,OAAO,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAC;AAC7E,OAAO,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAC;AACzE,OAAO,EAAE,0BAA0B,EAAE,MAAM,gDAAgD,CAAC;AAC5F,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAEvE,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AAKnE,OAAO,EACN,2BAA2B,EAE3B,0BAA0B,EAC1B,yBAAyB,EAEzB,wBAAwB,EAExB,uBAAuB,EACvB,sBAAsB,EAItB,gBAAgB,EAEhB,cAAc,EACd,kBAAkB,EAClB,iBAAiB,EAEjB,iBAAiB,EAKjB,uBAAuB,EACvB,mBAAmB,EAInB,0BAA0B,EAG1B,wBAAwB,EAGxB,iBAAiB,EACjB,eAAe,EAEf,mBAAmB,EAGnB,iBAAiB,EAGjB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@studyportals/search-api-interface",
-	"version": "3.0.0",
+	"version": "3.1.0",
 	"description": "Typescript library containing resources that facilitate integration with SearchApi",
 	"main": "index.js",
 	"scripts": {

package/src/cities/CitySearchFilters.d.ts

@@ -0,0 +1,16 @@
+import { CitySearchInput } from "./CitySearchInput";
+import { ICitySearchFilters } from "./ICitySearchFilters";
+export declare class CitySearchFilters implements ICitySearchFilters {
+    id?: string;
+    name?: string;
+    virtualPath?: string;
+    areaIds?: string[];
+    countryIsoCodes?: string[];
+    from(input: CitySearchInput): CitySearchFilters;
+    consideringId(id: string): CitySearchFilters;
+    consideringName(name: string): CitySearchFilters;
+    consideringVirtualPath(virtualPath: string): CitySearchFilters;
+    consideringAreaIds(areaIds: string[]): CitySearchFilters;
+    consideringCountryIsoCodes(countryIsoCodes: string[]): CitySearchFilters;
+    private numbersToStringsOrUndefined;
+}

package/src/cities/CitySearchFilters.js

@@ -0,0 +1,41 @@
+export class CitySearchFilters {
+    id;
+    name;
+    virtualPath;
+    areaIds;
+    countryIsoCodes;
+    from(input) {
+        this.id = input.id?.toString();
+        this.name = input.name;
+        this.virtualPath = input.virtualPath;
+        this.areaIds = this.numbersToStringsOrUndefined(input.areaIds);
+        this.countryIsoCodes = input.countryIsoCodes;
+        return this;
+    }
+    consideringId(id) {
+        this.id = id;
+        return this;
+    }
+    consideringName(name) {
+        this.name = name;
+        return this;
+    }
+    consideringVirtualPath(virtualPath) {
+        this.virtualPath = virtualPath;
+        return this;
+    }
+    consideringAreaIds(areaIds) {
+        this.areaIds = areaIds;
+        return this;
+    }
+    consideringCountryIsoCodes(countryIsoCodes) {
+        this.countryIsoCodes = countryIsoCodes;
+        return this;
+    }
+    numbersToStringsOrUndefined(values) {
+        if (values === undefined)
+            return;
+        return values.map(value => value.toString());
+    }
+}
+//# sourceMappingURL=CitySearchFilters.js.map

package/src/cities/CitySearchFilters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CitySearchFilters.js","sourceRoot":"","sources":["../../../src/cities/CitySearchFilters.ts"],"names":[],"mappings":"AAGA,MAAM,OAAO,iBAAiB;IACtB,EAAE,CAAU;IACZ,IAAI,CAAU;IACd,WAAW,CAAU;IACrB,OAAO,CAAY;IACnB,eAAe,CAAY;IAE3B,IAAI,CAAC,KAAsB;QACjC,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC;QAC/B,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;QAC7C,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,aAAa,CAAC,EAAU;QAC9B,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,eAAe,CAAC,IAAY;QAClC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,sBAAsB,CAAC,WAAmB;QAChD,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,kBAAkB,CAAC,OAAiB;QAC1C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,0BAA0B,CAAC,eAAyB;QAC1D,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,OAAO,IAAI,CAAC;IACb,CAAC;IAEO,2BAA2B,CAAC,MAA4B;QAC/D,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO;QACjC,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC9C,CAAC;CACD"}

package/src/cities/CitySearchInput.d.ts

@@ -0,0 +1,7 @@
+export type CitySearchInput = {
+    id?: number;
+    name?: string;
+    virtualPath?: string;
+    areaIds?: number[];
+    countryIsoCodes?: string[];
+};

package/src/cities/CitySearchInput.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=CitySearchInput.js.map

package/src/cities/CitySearchInput.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CitySearchInput.js","sourceRoot":"","sources":["../../../src/cities/CitySearchInput.ts"],"names":[],"mappings":""}

package/src/cities/ICity.d.ts

@@ -0,0 +1,7 @@
+export interface ICity {
+    readonly id: number;
+    readonly name: string;
+    readonly virtualPath: string;
+    readonly areaId: number | null;
+    readonly countryIsoCode: string;
+}

package/src/cities/ICity.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ICity.js.map

package/src/cities/ICity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ICity.js","sourceRoot":"","sources":["../../../src/cities/ICity.ts"],"names":[],"mappings":""}

package/src/cities/ICitySearchFilters.d.ts

@@ -0,0 +1,7 @@
+export interface ICitySearchFilters {
+    readonly id?: string;
+    readonly name?: string;
+    readonly virtualPath?: string;
+    readonly areaIds?: string[];
+    readonly countryIsoCodes?: string[];
+}

package/src/cities/ICitySearchFilters.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ICitySearchFilters.js.map

package/src/cities/ICitySearchFilters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ICitySearchFilters.js","sourceRoot":"","sources":["../../../src/cities/ICitySearchFilters.ts"],"names":[],"mappings":""}

package/src/cities/ICitySearchResponse.d.ts

@@ -0,0 +1,6 @@
+import { HitsTotalRelation } from "../HitsTotalRelation";
+export interface ICitySearchResponse<T> {
+    readonly cities: readonly T[];
+    readonly hitsTotal: number;
+    readonly hitsTotalRelation: HitsTotalRelation;
+}

package/src/cities/ICitySearchResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ICitySearchResponse.js.map

package/src/cities/ICitySearchResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ICitySearchResponse.js","sourceRoot":"","sources":["../../../src/cities/ICitySearchResponse.ts"],"names":[],"mappings":""}

package/src/cities/SearchApiCityClient.d.ts

@@ -0,0 +1,11 @@
+import { ICity } from "@studyportals/domain-client";
+import { SearchApiClientBase } from "../SearchApiClientBase";
+import { ICitySearchFilters } from "./ICitySearchFilters";
+import { ICitySearchResponse } from "./ICitySearchResponse";
+import { IRequestSender, ISuperAgentRequestFactory } from "@studyportals/mb-platform-http-requests";
+export declare class SearchApiCityClient extends SearchApiClientBase {
+    private readonly requestFactory;
+    private readonly requestSender;
+    constructor(apiUriBase: string, requestFactory: ISuperAgentRequestFactory, requestSender: IRequestSender);
+    search(filters: ICitySearchFilters, resultSize: number, resultOffset: number): Promise<ICitySearchResponse<ICity>>;
+}

package/src/cities/SearchApiCityClient.js

@@ -0,0 +1,17 @@
+import { SearchApiClientBase } from "../SearchApiClientBase";
+export class SearchApiCityClient extends SearchApiClientBase {
+    requestFactory;
+    requestSender;
+    constructor(apiUriBase, requestFactory, requestSender) {
+        super("scholarships", apiUriBase);
+        this.requestFactory = requestFactory;
+        this.requestSender = requestSender;
+    }
+    async search(filters, resultSize, resultOffset) {
+        const request = this.requestFactory.get(this.constructUri("search"))
+            .query({ ...filters, resultSize, resultOffset });
+        const result = await this.requestSender.sendAndExtractBody(request);
+        return result;
+    }
+}
+//# sourceMappingURL=SearchApiCityClient.js.map

package/src/cities/SearchApiCityClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SearchApiCityClient.js","sourceRoot":"","sources":["../../../src/cities/SearchApiCityClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAK7D,MAAM,OAAO,mBAAoB,SAAQ,mBAAmB;IAC1C,cAAc,CAA4B;IAC1C,aAAa,CAAiB;IAE/C,YAAmB,UAAkB,EAC9B,cAAyC,EACzC,aAA6B;QAEnC,KAAK,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;QAElC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACpC,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,OAA2B,EAAE,UAAkB,EAAE,YAAoB;QACxF,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;aAClE,KAAK,CAAC,EAAC,GAAG,OAAO,EAAE,UAAU,EAAE,YAAY,EAAC,CAAC,CAAC;QAEhD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAA6B,OAAO,CAAC,CAAC;QAEhG,OAAO,MAAM,CAAC;IACf,CAAC;CACD"}