@studyportals/search-api-interface 5.2.4 → 5.2.6

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 CHANGED
@@ -36,5 +36,6 @@ import { ICity } from "./src/cities/ICity";
36
36
  import { ProgrammeCardType } from "./src/programmes/ProgrammeCardType";
37
37
  import { IOrganisationIdAndName } from './src/organisations/IOrganisationIdAndName';
38
38
  import { OrganisationSortType } from './src/organisations/OrganisationSortType';
39
- export { SearchApiOrganisationClient, IOrganisationIdAndName, IOrganisationSearchResponse, IOrganisationSearchFilters, OrganisationInsightValues, OrganisationSearchFilters, OrganisationSortType, SearchApiProgrammeClient, IProgrammeSearchResponse, IProgrammeSearchFilters, ProgrammeSearchFilters, OrganisationSearchInput, ProgrammeSearchInput, IProgrammeResult, 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, };
39
+ import { IOrganisationResult } from "./src/organisations/IOrganisationResult";
40
+ export { SearchApiOrganisationClient, IOrganisationIdAndName, IOrganisationSearchResponse, IOrganisationSearchFilters, OrganisationInsightValues, OrganisationSearchFilters, OrganisationSortType, IOrganisationResult, SearchApiProgrammeClient, IProgrammeSearchResponse, IProgrammeSearchFilters, ProgrammeSearchFilters, OrganisationSearchInput, ProgrammeSearchInput, IProgrammeResult, 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, };
40
41
  export * from "./src/enums";
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;AAGrF,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,EACN,2BAA2B,EAG3B,0BAA0B,EAE1B,yBAAyB,EACzB,oBAAoB,EAEpB,wBAAwB,EAExB,uBAAuB,EACvB,sBAAsB,EAItB,gBAAgB,EAEhB,cAAc,EACd,kBAAkB,EAClB,iBAAiB,EAEjB,iBAAiB,EACjB,iBAAiB,EAOjB,uBAAuB,EACvB,mBAAmB,EAInB,0BAA0B,EAG1B,wBAAwB,EAGxB,iBAAiB,EACjB,eAAe,EAEf,mBAAmB,EAGnB,iBAAiB,GAGjB,CAAA;AAED,cAAc,aAAa,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;AAGrF,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;AAGhF,OAAO,EACN,2BAA2B,EAG3B,0BAA0B,EAE1B,yBAAyB,EACzB,oBAAoB,EAGpB,wBAAwB,EAExB,uBAAuB,EACvB,sBAAsB,EAItB,gBAAgB,EAEhB,cAAc,EACd,kBAAkB,EAClB,iBAAiB,EAEjB,iBAAiB,EACjB,iBAAiB,EAOjB,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
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@studyportals/search-api-interface",
3
- "version": "5.2.4",
3
+ "version": "5.2.6",
4
4
  "description": "Typescript library containing resources that facilitate integration with SearchApi",
5
5
  "main": "index.js",
6
6
  "scripts": {
@@ -1,4 +1,5 @@
1
- export interface IOrganisationResult {
1
+ export interface IOrganisationResult<T> {
2
+ card: T;
2
3
  ranking_discipline_for_card?: number;
3
4
  globalRankingPosition?: number;
4
5
  }
@@ -1,8 +1,7 @@
1
1
  import { HitsTotalRelation } from "../HitsTotalRelation";
2
- import { IOrganisationResult } from "./IOrganisationResult";
3
2
  import { OrganisationInsightValues } from "./OrganisationInsightValues";
4
3
  export interface IOrganisationSearchResponse<T> {
5
- readonly organisations: readonly (T & IOrganisationResult)[];
4
+ readonly organisations: readonly T[];
6
5
  readonly hitsTotal: number;
7
6
  readonly hitsTotalRelation: HitsTotalRelation;
8
7
  readonly insights?: OrganisationInsightValues;
@@ -14,14 +14,9 @@ export class SearchApiOrganisationClient extends SearchApiClientBase {
14
14
  const request = this.requestFactory.get(this.constructUri("search"))
15
15
  .query({ ...filters, resultSize, resultOffset });
16
16
  const result = await this.requestSender.sendAndExtractBody(request);
17
- const mappedOrganisations = result.organisations.map((result) => ({
18
- ...this.organisationCardFactory.fromDescription(result),
19
- ranking_discipline_for_card: result.ranking_discipline_for_card,
20
- globalRankingPosition: result.globalRankingPosition
21
- }));
22
17
  return {
23
18
  ...result,
24
- organisations: mappedOrganisations
19
+ organisations: this.organisationCardFactory.fromDescriptions([...result.organisations])
25
20
  };
26
21
  }
27
22
  async searchIds(filters, resultSize, resultOffset) {
@@ -1 +1 @@
1
- {"version":3,"file":"SearchApiOrganisationClient.js","sourceRoot":"","sources":["../../../src/organisations/SearchApiOrganisationClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAE7D,OAAO,EAAqB,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAMxF,MAAM,OAAO,2BAA4B,SAAQ,mBAAmB;IAElD,cAAc,CAA4B;IAC1C,aAAa,CAAiB;IAC9B,uBAAuB,GAAG,IAAI,sBAAsB,EAAE,CAAC;IAExE,YAAmB,UAAkB,EACpC,cAAyC,EACzC,aAA6B;QAE7B,KAAK,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;QAEnC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,uBAAuB,GAAG,IAAI,sBAAsB,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IAC5E,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,OAAmC,EAAE,UAAkB,EAAE,YAAoB;QACrG,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;aAClE,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC,CAAC;QAElD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAiD,OAAO,CAAC,CAAC;QACpH,MAAM,mBAAmB,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YACjE,GAAG,IAAI,CAAC,uBAAuB,CAAC,eAAe,CAAC,MAAM,CAAC;YACvD,2BAA2B,EAAE,MAAM,CAAC,2BAA2B;YAC/D,qBAAqB,EAAE,MAAM,CAAC,qBAAqB;SACnD,CAAC,CAAC,CAAC;QAEJ,OAAO;YACN,GAAG,MAAM;YACT,aAAa,EAAE,mBAAmB;SAClC,CAAA;IACF,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,OAAmC,EAAE,UAAkB,EAAE,YAAoB;QACnG,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;aACtE,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC,CAAC;QAElD,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAsC,OAAO,CAAC,CAAC;IAClG,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,OAAmC,EAAE,UAAkB,EAAE,YAAoB;QACrG,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;aACxE,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC,CAAC;QAClD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAsD,OAAO,CAAC,CAAC;QAEzH,OAAO,MAAM,CAAC;IACf,CAAC;CACD"}
1
+ {"version":3,"file":"SearchApiOrganisationClient.js","sourceRoot":"","sources":["../../../src/organisations/SearchApiOrganisationClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAE7D,OAAO,EAAqB,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAMxF,MAAM,OAAO,2BAA4B,SAAQ,mBAAmB;IAElD,cAAc,CAA4B;IAC1C,aAAa,CAAiB;IAC9B,uBAAuB,GAAG,IAAI,sBAAsB,EAAE,CAAC;IAExE,YAAmB,UAAkB,EACpC,cAAyC,EACzC,aAA6B;QAE7B,KAAK,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;QAEnC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,uBAAuB,GAAG,IAAI,sBAAsB,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IAC5E,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,OAAmC,EAAE,UAAkB,EAAE,YAAoB;QACrG,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;aAClE,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC,CAAC;QAElD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAiD,OAAO,CAAC,CAAC;QAEpH,OAAO;YACN,GAAG,MAAM;YACT,aAAa,EAAE,IAAI,CAAC,uBAAuB,CAAC,gBAAgB,CAAC,CAAC,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC;SACvF,CAAA;IACF,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,OAAmC,EAAE,UAAkB,EAAE,YAAoB;QACnG,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;aACtE,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC,CAAC;QAElD,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAsC,OAAO,CAAC,CAAC;IAClG,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,OAAmC,EAAE,UAAkB,EAAE,YAAoB;QACrG,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;aACxE,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC,CAAC;QAClD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAsD,OAAO,CAAC,CAAC;QAEzH,OAAO,MAAM,CAAC;IACf,CAAC;CACD"}