@studyportals/search-api-interface 2.5.0 → 2.6.0-beta.0

package/index.d.ts

@@ -25,4 +25,9 @@ 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";
+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 };

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ScholarshipType = exports.ScholarshipFormat = exports.ScholarshipSearchFilters = exports.SearchApiScholarshipClient = exports.ProgrammeFilterType = exports.TextSearchAlgorithmType = exports.ProgrammeSortType = exports.HitsTotalRelation = exports.DeliveryMethodEnum = exports.DegreeTypeEnum = exports.IProgrammeResult = exports.ProgrammeSearchFilters = exports.IProgrammeSearchFilters = exports.SearchApiProgrammeClient = exports.OrganisationSearchFilters = exports.IOrganisationSearchFilters = exports.SearchApiOrganisationClient = void 0;
+exports.CitySearchFilters = exports.SearchApiCityClient = exports.ScholarshipType = exports.ScholarshipFormat = exports.ScholarshipSearchFilters = exports.SearchApiScholarshipClient = exports.ProgrammeFilterType = exports.TextSearchAlgorithmType = exports.ProgrammeSortType = exports.HitsTotalRelation = exports.DeliveryMethodEnum = exports.DegreeTypeEnum = exports.IProgrammeResult = exports.ProgrammeSearchFilters = exports.IProgrammeSearchFilters = exports.SearchApiProgrammeClient = exports.OrganisationSearchFilters = exports.IOrganisationSearchFilters = exports.SearchApiOrganisationClient = void 0;
 const HitsTotalRelation_1 = require("./src/HitsTotalRelation");
 Object.defineProperty(exports, "HitsTotalRelation", { enumerable: true, get: function () { return HitsTotalRelation_1.HitsTotalRelation; } });
 const DegreeTypeEnum_1 = require("./src/organisations/DegreeTypeEnum");
@@ -35,4 +35,8 @@ const ScholarshipTypeEnum_1 = require("./src/scholarships/ScholarshipTypeEnum");
 Object.defineProperty(exports, "ScholarshipType", { enumerable: true, get: function () { return ScholarshipTypeEnum_1.ScholarshipType; } });
 const SearchApiScholarshipsClient_1 = require("./src/scholarships/SearchApiScholarshipsClient");
 Object.defineProperty(exports, "SearchApiScholarshipClient", { enumerable: true, get: function () { return SearchApiScholarshipsClient_1.SearchApiScholarshipClient; } });
+const SearchApiCityClient_1 = require("./src/cities/SearchApiCityClient");
+Object.defineProperty(exports, "SearchApiCityClient", { enumerable: true, get: function () { return SearchApiCityClient_1.SearchApiCityClient; } });
+const CitySearchFilters_1 = require("./src/cities/CitySearchFilters");
+Object.defineProperty(exports, "CitySearchFilters", { enumerable: true, get: function () { return CitySearchFilters_1.CitySearchFilters; } });
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,+DAA4D;AA6C3D,kGA7CQ,qCAAiB,OA6CR;AA5ClB,uEAAoE;AA0CnE,+FA1CQ,+BAAc,OA0CR;AAzCf,+EAA4E;AA0C3E,mGA1CQ,uCAAkB,OA0CR;AAzCnB,+FAA4F;AA4B3F,2GA5BQ,uDAA0B,OA4BR;AA1B3B,6FAA0F;AA2BzF,0GA3BQ,qDAAyB,OA2BR;AAzB1B,iGAA8F;AAsB7F,4GAtBQ,yDAA2B,OAsBR;AArB5B,wEAAqE;AAiCpE,iGAjCQ,mCAAgB,OAiCR;AAhCjB,sFAAmF;AA2BlF,wGA3BQ,iDAAuB,OA2BR;AAzBxB,oFAAiF;AA0BhF,uGA1BQ,+CAAsB,OA0BR;AAxBvB,wFAAqF;AAqBpF,yGArBQ,mDAAwB,OAqBR;AAnBzB,0EAAuE;AAgCtE,kGAhCQ,qCAAiB,OAgCR;AA/BlB,2EAAwE;AAoCvE,wGApCQ,iDAAuB,OAoCR;AAnCxB,8EAA2E;AAoC1E,oGApCQ,yCAAmB,OAoCR;AAhCpB,0FAAuF;AAuCtF,yGAvCQ,mDAAwB,OAuCR;AApCzB,oFAA6E;AAuC5E,kGAvCQ,yCAAiB,OAuCR;AAtClB,gFAAyE;AAuCxE,gGAvCQ,qCAAe,OAuCR;AAtChB,gGAA4F;AA+B3F,2GA/BQ,wDAA0B,OA+BR"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,+DAA4D;AAkD3D,kGAlDQ,qCAAiB,OAkDR;AAjDlB,uEAAoE;AA+CnE,+FA/CQ,+BAAc,OA+CR;AA9Cf,+EAA4E;AA+C3E,mGA/CQ,uCAAkB,OA+CR;AA9CnB,+FAA4F;AAiC3F,2GAjCQ,uDAA0B,OAiCR;AA/B3B,6FAA0F;AAgCzF,0GAhCQ,qDAAyB,OAgCR;AA9B1B,iGAA8F;AA2B7F,4GA3BQ,yDAA2B,OA2BR;AA1B5B,wEAAqE;AAsCpE,iGAtCQ,mCAAgB,OAsCR;AArCjB,sFAAmF;AAgClF,wGAhCQ,iDAAuB,OAgCR;AA9BxB,oFAAiF;AA+BhF,uGA/BQ,+CAAsB,OA+BR;AA7BvB,wFAAqF;AA0BpF,yGA1BQ,mDAAwB,OA0BR;AAxBzB,0EAAuE;AAqCtE,kGArCQ,qCAAiB,OAqCR;AApClB,2EAAwE;AAyCvE,wGAzCQ,iDAAuB,OAyCR;AAxCxB,8EAA2E;AAyC1E,oGAzCQ,yCAAmB,OAyCR;AArCpB,0FAAuF;AA4CtF,yGA5CQ,mDAAwB,OA4CR;AAzCzB,oFAA6E;AA4C5E,kGA5CQ,yCAAiB,OA4CR;AA3ClB,gFAAyE;AA4CxE,gGA5CQ,qCAAe,OA4CR;AA3ChB,gGAA4F;AAoC3F,2GApCQ,wDAA0B,OAoCR;AAnC3B,0EAAuE;AA4CtE,oGA5CQ,yCAAmB,OA4CR;AA1CpB,sEAAmE;AA6ClE,kGA7CQ,qCAAiB,OA6CR"}

package/package.json

@@ -1,32 +1,32 @@
-{
-	"name": "@studyportals/search-api-interface",
-	"version": "2.5.0",
-	"description": "Typescript library containing resources that facilitate integration with SearchApi",
-	"main": "index.js",
-	"scripts": {
-		"compile": "rm -fR bin && npx tsc",
-		"deploy-patch": "npm version patch && npm run deploy",
-		"deploy-minor": "npm version minor && npm run deploy",
-		"deploy-major": "npm version major && npm run deploy",
-		"deploy-beta": "npm version prerelease && npm run prepare-deployment && npm publish ./bin --tag beta",
-		"deploy": "npm run prepare-deployment && npm publish ./bin",
-		"prepare-deployment": "npm run compile && cp package.json bin/package.json",
-		"lint": "eslint . --ext .ts",
-		"lint:fix": "eslint . --ext .ts --fix"
-	},
-	"author": "Seal Team Six",
-	"license": "BSD-3-Clause",
-	"devDependencies": {
-		"@studyportals/code-style": "^1.7.0",
-		"@types/superagent": "^4.1.15",
-		"@typescript-eslint/eslint-plugin": "^5.27.0",
-		"@typescript-eslint/parser": "^5.27.0",
-		"eslint": "^8.17.0",
-		"typescript": "^5.5.4",
-		"typescript-transform-paths": "^3.4.6"
-	},
-	"dependencies": {
-		"@studyportals/domain-client": "^5.4.4",
-		"@studyportals/search-filters": "^4.11.2"
-	}
-}
+{
+	"name": "@studyportals/search-api-interface",
+	"version": "2.6.0-beta.0",
+	"description": "Typescript library containing resources that facilitate integration with SearchApi",
+	"main": "index.js",
+	"scripts": {
+		"compile": "rm -fR bin && npx tsc",
+		"deploy-patch": "npm version patch && npm run deploy",
+		"deploy-minor": "npm version minor && npm run deploy",
+		"deploy-major": "npm version major && npm run deploy",
+		"deploy-beta": "npm run prepare-deployment && npm publish ./bin --tag beta",
+		"deploy": "npm run prepare-deployment && npm publish ./bin",
+		"prepare-deployment": "npm run compile && cp package.json bin/package.json",
+		"lint": "eslint . --ext .ts",
+		"lint:fix": "eslint . --ext .ts --fix"
+	},
+	"author": "Seal Team Six",
+	"license": "BSD-3-Clause",
+	"devDependencies": {
+		"@studyportals/code-style": "^1.7.0",
+		"@types/superagent": "^4.1.15",
+		"@typescript-eslint/eslint-plugin": "^5.27.0",
+		"@typescript-eslint/parser": "^5.27.0",
+		"eslint": "^8.17.0",
+		"typescript": "^5.5.4",
+		"typescript-transform-paths": "^3.4.6"
+	},
+	"dependencies": {
+		"@studyportals/domain-client": "^5.4.4",
+		"@studyportals/search-filters": "^4.11.2"
+	}
+}

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 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CitySearchFilters = void 0;
+class CitySearchFilters {
+    from(input) {
+        var _a;
+        this.id = (_a = input.id) === null || _a === void 0 ? void 0 : _a.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());
+    }
+}
+exports.CitySearchFilters = CitySearchFilters;
+//# 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,MAAa,iBAAiB;IAOtB,IAAI,CAAC,KAAsB;;QACjC,IAAI,CAAC,EAAE,GAAG,MAAA,KAAK,CAAC,EAAE,0CAAE,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;AA7CD,8CA6CC"}

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,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# 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,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# 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,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# 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,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# 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,30 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchApiCityClient = void 0;
+const SearchApiClientBase_1 = require("../SearchApiClientBase");
+class SearchApiCityClient extends SearchApiClientBase_1.SearchApiClientBase {
+    constructor(apiUriBase, requestFactory, requestSender) {
+        super("scholarships", apiUriBase);
+        this.requestFactory = requestFactory;
+        this.requestSender = requestSender;
+    }
+    search(filters, resultSize, resultOffset) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const request = this.requestFactory.get(this.constructUri("search"))
+                .query(Object.assign(Object.assign({}, filters), { resultSize, resultOffset }));
+            const result = yield this.requestSender.sendAndExtractBody(request);
+            return result;
+        });
+    }
+}
+exports.SearchApiCityClient = SearchApiCityClient;
+//# 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,gEAA6D;AAK7D,MAAa,mBAAoB,SAAQ,yCAAmB;IAI3D,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;IAEY,MAAM,CAAC,OAA2B,EAAE,UAAkB,EAAE,YAAoB;;YACxF,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;iBAClE,KAAK,iCAAK,OAAO,KAAE,UAAU,EAAE,YAAY,IAAE,CAAC;YAEhD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAA6B,OAAO,CAAC,CAAC;YAEhG,OAAO,MAAM,CAAC;QACf,CAAC;KAAA;CACD;AAtBD,kDAsBC"}