@studyportals/search-api-interface 5.2.5 → 5.2.7-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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@studyportals/search-api-interface",
3
- "version": "5.2.5",
3
+ "version": "5.2.7-0",
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;
@@ -4,12 +4,13 @@ import { IOrganisationCard } from "@studyportals/domain-client";
4
4
  import { IOrganisationSearchResponse } from "./IOrganisationSearchResponse";
5
5
  import { IOrganisationSearchFilters } from "./IOrganisationSearchFilters";
6
6
  import { IOrganisationIdAndName } from "./IOrganisationIdAndName";
7
+ import { IOrganisationResult } from "./IOrganisationResult";
7
8
  export declare class SearchApiOrganisationClient extends SearchApiClientBase {
8
9
  private readonly requestFactory;
9
10
  private readonly requestSender;
10
11
  private readonly organisationCardFactory;
11
12
  constructor(apiUriBase: string, requestFactory: ISuperAgentRequestFactory, requestSender: IRequestSender);
12
- searchCards(filters: IOrganisationSearchFilters, resultSize: number, resultOffset: number): Promise<IOrganisationSearchResponse<IOrganisationCard>>;
13
+ searchCards(filters: IOrganisationSearchFilters, resultSize: number, resultOffset: number): Promise<IOrganisationSearchResponse<IOrganisationResult<IOrganisationCard>>>;
13
14
  searchIds(filters: IOrganisationSearchFilters, resultSize: number, resultOffset: number): Promise<IOrganisationSearchResponse<string>>;
14
15
  searchNames(filters: IOrganisationSearchFilters, resultSize: number, resultOffset: number): Promise<IOrganisationSearchResponse<IOrganisationIdAndName>>;
15
16
  }
@@ -14,10 +14,10 @@ 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
17
+ const mappedOrganisations = result.organisations.map(org => ({
18
+ card: this.organisationCardFactory.fromDescription(org.card),
19
+ ranking_discipline_for_card: org.ranking_discipline_for_card,
20
+ globalRankingPosition: org.globalRankingPosition
21
21
  }));
22
22
  return {
23
23
  ...result,
@@ -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;AAOxF,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,CAAsE,OAAO,CAAC,CAAC;QACzI,MAAM,mBAAmB,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC5D,IAAI,EAAE,IAAI,CAAC,uBAAuB,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC;YAC5D,2BAA2B,EAAE,GAAG,CAAC,2BAA2B;YAC5D,qBAAqB,EAAE,GAAG,CAAC,qBAAqB;SAChD,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"}