@studyportals/search-api-interface 5.4.6 → 5.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +2 -1
- package/index.js.map +1 -1
- package/package.json +1 -1
- package/src/facets/FacetProgrammesByOrganisationIdsResponse.d.ts +6 -0
- package/src/facets/FacetProgrammesByOrganisationIdsResponse.js +2 -0
- package/src/facets/FacetProgrammesByOrganisationIdsResponse.js.map +1 -0
- package/src/programmes/SearchApiProgrammeClient.d.ts +2 -0
- package/src/programmes/SearchApiProgrammeClient.js +6 -0
- package/src/programmes/SearchApiProgrammeClient.js.map +1 -1
package/index.d.ts
CHANGED
|
@@ -14,6 +14,7 @@ import { ProgrammeSearchFilters } from "./src/programmes/ProgrammeSearchFilters.
|
|
|
14
14
|
import { ProgrammeSearchInput } from "./src/programmes/ProgrammeSearchInput.js";
|
|
15
15
|
import { SearchApiProgrammeClient } from "./src/programmes/SearchApiProgrammeClient.js";
|
|
16
16
|
import { FacetResponseType, FacetValues } from "./src/facets/FacetResponseType.js";
|
|
17
|
+
import { FacetProgrammesByOrganisationIdsItem, FacetProgrammesByOrganisationIdsResponse } from "./src/facets/FacetProgrammesByOrganisationIdsResponse.js";
|
|
17
18
|
import { InsightValues } from "./src/insights/InsightValues.js";
|
|
18
19
|
import { ProgrammeSortType } from "./src/programmes/ProgrammeSortType.js";
|
|
19
20
|
import { TextSearchAlgorithmType } from "./src/TextSearchAlgorithmType.js";
|
|
@@ -38,5 +39,5 @@ import { IOrganisationIdAndName } from './src/organisations/IOrganisationIdAndNa
|
|
|
38
39
|
import { OrganisationSortType } from './src/organisations/OrganisationSortType.js';
|
|
39
40
|
import { IOrganisationResult } from "./src/organisations/IOrganisationResult.js";
|
|
40
41
|
import { mapDegreeToEducationalLevel, mapEducationalLevelToDegree } from "./src/maps/DegreeToEducationalLevelMap.js";
|
|
41
|
-
export { SearchApiOrganisationClient, IOrganisationIdAndName, IOrganisationSearchResponse, IOrganisationSearchFilters, OrganisationInsightValues, OrganisationSearchFilters, OrganisationSortType, IOrganisationResult, SearchApiProgrammeClient, IProgrammeSearchResponse, IProgrammeSearchFilters, ProgrammeSearchFilters, OrganisationSearchInput, ProgrammeSearchInput, IProgrammeResult, mapDegreeToEducationalLevel, mapEducationalLevelToDegree, DegreeTypeEnum, DeliveryMethodEnum, HitsTotalRelation, ProgrammeSortType, ProgrammeCardType, FacetResponseType, FacetValues, InsightValues, TextSearchAlgorithmType, ProgrammeFilterType, ISuggestionResult, SearchApiScholarshipClient, IScholarshipSearchResponse, IScholarshipSearchFilters, ScholarshipSearchFilters, ScholarshipSearchInput, IScholarshipSearchCountResponse, ScholarshipFormat, ScholarshipType, SearchApiCityClient, ICitySearchResponse, ICitySearchFilters, CitySearchFilters, CitySearchInput, ICity, };
|
|
42
|
+
export { SearchApiOrganisationClient, IOrganisationIdAndName, IOrganisationSearchResponse, IOrganisationSearchFilters, OrganisationInsightValues, OrganisationSearchFilters, OrganisationSortType, IOrganisationResult, SearchApiProgrammeClient, IProgrammeSearchResponse, IProgrammeSearchFilters, ProgrammeSearchFilters, OrganisationSearchInput, ProgrammeSearchInput, IProgrammeResult, mapDegreeToEducationalLevel, mapEducationalLevelToDegree, DegreeTypeEnum, DeliveryMethodEnum, HitsTotalRelation, ProgrammeSortType, ProgrammeCardType, FacetResponseType, FacetValues, FacetProgrammesByOrganisationIdsItem, FacetProgrammesByOrganisationIdsResponse, InsightValues, TextSearchAlgorithmType, ProgrammeFilterType, ISuggestionResult, SearchApiScholarshipClient, IScholarshipSearchResponse, IScholarshipSearchFilters, ScholarshipSearchFilters, ScholarshipSearchInput, IScholarshipSearchCountResponse, ScholarshipFormat, ScholarshipType, SearchApiCityClient, ICitySearchResponse, ICitySearchFilters, CitySearchFilters, CitySearchInput, ICity, };
|
|
42
43
|
export * from "./src/enums/index.js";
|
package/index.js.map
CHANGED
|
@@ -1 +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;AAG5F,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;
|
|
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;AAG5F,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;AAIrF,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;AAInE,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AAEvE,OAAO,EAAE,oBAAoB,EAAE,MAAM,0CAA0C,CAAC;AAEhF,OAAO,EAAE,2BAA2B,EAAE,2BAA2B,EAAE,MAAM,wCAAwC,CAAC;AAElH,OAAO,EACN,2BAA2B,EAG3B,0BAA0B,EAE1B,yBAAyB,EACzB,oBAAoB,EAGpB,wBAAwB,EAExB,uBAAuB,EACvB,sBAAsB,EAItB,gBAAgB,EAEhB,2BAA2B,EAC3B,2BAA2B,EAE3B,cAAc,EACd,kBAAkB,EAClB,iBAAiB,EAEjB,iBAAiB,EACjB,iBAAiB,EAUjB,uBAAuB,EACvB,mBAAmB,EAInB,0BAA0B,EAG1B,wBAAwB,EAGxB,iBAAiB,EACjB,eAAe,EAEf,mBAAmB,EAGnB,iBAAiB,GAGjB,CAAA;AAED,cAAc,aAAa,CAAC"}
|
package/package.json
CHANGED
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { FacetResponseType } from "./FacetResponseType.js";
|
|
2
|
+
export interface FacetProgrammesByOrganisationIdsItem {
|
|
3
|
+
organisationId: string;
|
|
4
|
+
facets: FacetResponseType[];
|
|
5
|
+
}
|
|
6
|
+
export type FacetProgrammesByOrganisationIdsResponse = FacetProgrammesByOrganisationIdsItem[];
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"FacetProgrammesByOrganisationIdsResponse.js","sourceRoot":"","sources":["../../../src/facets/FacetProgrammesByOrganisationIdsResponse.ts"],"names":[],"mappings":""}
|
|
@@ -4,6 +4,7 @@ import { IProgrammeCard, PortalMap, ProgrammeCard } from "@studyportals/domain-c
|
|
|
4
4
|
import { IProgrammeSearchResponse } from "./IProgrammeSearchResponse.js";
|
|
5
5
|
import { IProgrammeResult } from "./IProgrammeResult.js";
|
|
6
6
|
import { IProgrammeSearchFilters } from "./IProgrammeSearchFilters.js";
|
|
7
|
+
import { FacetProgrammesByOrganisationIdsResponse } from "../facets/FacetProgrammesByOrganisationIdsResponse.js";
|
|
7
8
|
export declare class SearchApiProgrammeClient extends SearchApiClientBase {
|
|
8
9
|
private readonly requestFactory;
|
|
9
10
|
private readonly requestSender;
|
|
@@ -12,4 +13,5 @@ export declare class SearchApiProgrammeClient extends SearchApiClientBase {
|
|
|
12
13
|
searchCards(filters: IProgrammeSearchFilters, resultSize: number, resultOffset: number): Promise<IProgrammeSearchResponse<IProgrammeResult<IProgrammeCard>>>;
|
|
13
14
|
searchCardsV2(filters: IProgrammeSearchFilters, resultSize: number, resultOffset: number): Promise<IProgrammeSearchResponse<IProgrammeResult<ProgrammeCard>>>;
|
|
14
15
|
searchIds(filters: any, resultSize: number, resultOffset: number): Promise<IProgrammeSearchResponse<string>>;
|
|
16
|
+
facetProgrammesByOrganisationIds(filters: any, facets: any): Promise<FacetProgrammesByOrganisationIdsResponse>;
|
|
15
17
|
}
|
|
@@ -45,5 +45,11 @@ export class SearchApiProgrammeClient extends SearchApiClientBase {
|
|
|
45
45
|
.query({ ...filters, resultSize, resultOffset });
|
|
46
46
|
return await this.requestSender.sendAndExtractBody(request);
|
|
47
47
|
}
|
|
48
|
+
async facetProgrammesByOrganisationIds(filters, facets) {
|
|
49
|
+
// The server expects organisationIds and facets (and other optional filters). Forward these as query parameters.
|
|
50
|
+
const request = this.requestFactory.get(this.constructUri("facets/by/organisation"))
|
|
51
|
+
.query({ ...filters, facets });
|
|
52
|
+
return await this.requestSender.sendAndExtractBody(request);
|
|
53
|
+
}
|
|
48
54
|
}
|
|
49
55
|
//# sourceMappingURL=SearchApiProgrammeClient.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SearchApiProgrammeClient.js","sourceRoot":"","sources":["../../../src/programmes/SearchApiProgrammeClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAE7D,OAAO,EAA6B,aAAa,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;
|
|
1
|
+
{"version":3,"file":"SearchApiProgrammeClient.js","sourceRoot":"","sources":["../../../src/programmes/SearchApiProgrammeClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAE7D,OAAO,EAA6B,aAAa,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAM5G,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD,MAAM,OAAO,wBAAyB,SAAQ,mBAAmB;IAE/C,cAAc,CAA4B;IAC1C,aAAa,CAAiB;IAC9B,oBAAoB,GAAG,IAAI,mBAAmB,EAAE,CAAC;IAElE,YAAmB,UAAkB,EAC9B,cAAyC,EACzC,aAA6B,EAC7B,SAAqB;QAE3B,KAAK,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;QAEhC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,oBAAoB,GAAG,IAAI,mBAAmB,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,SAAS,CAAC,CAAC;IACjF,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,OAAgC,EAAE,UAAkB,EAAE,YAAoB;QAClG,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,CAAgE,OAAO,CAAC,CAAC;QACnI,MAAM,gBAAgB,GAAgD,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YACtG,IAAI,EAAE,IAAI,CAAC,oBAAoB,CAAC,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC;YAC5D,UAAU,EAAE,MAAM,CAAC,UAAU;SAC7B,CAAC,CAAC,CAAC;QAEJ,OAAO;YACN,GAAG,MAAM;YACT,UAAU,EAAE,gBAAgB;YAC5B,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI,EAAE;SAC3B,CAAA;IACF,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,OAAgC,EAAE,UAAkB,EAAE,YAAoB;QACpG,OAAO,CAAC,QAAQ,GAAG,iBAAiB,CAAC,EAAE,CAAC;QAExC,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,CAA4D,OAAO,CAAC,CAAC;QAC/H,MAAM,gBAAgB,GAA+C,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YACrG,IAAI,EAAE,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC;YACzC,UAAU,EAAE,MAAM,CAAC,UAAU;SAC7B,CAAC,CAAC,CAAC;QAEJ,OAAO;YACN,GAAG,MAAM;YACT,UAAU,EAAE,gBAAgB;YAC5B,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI,EAAE;SAC3B,CAAA;IACF,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,OAAY,EAAE,UAAkB,EAAE,YAAoB;QAC5E,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;aACtE,KAAK,CAAC,EAAC,GAAG,OAAO,EAAE,UAAU,EAAE,YAAY,EAAC,CAAC,CAAC;QAEhD,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAmC,OAAO,CAAC,CAAC;IAC/F,CAAC;IAEM,KAAK,CAAC,gCAAgC,CAAC,OAAY,EAAE,MAAW;QACtE,iHAAiH;QACjH,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,wBAAwB,CAAC,CAAC;aAClF,KAAK,CAAC,EAAC,GAAG,OAAO,EAAE,MAAM,EAAC,CAAC,CAAC;QAE9B,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAA2C,OAAO,CAAC,CAAC;IACvG,CAAC;CACD"}
|