@studyportals/search-api-interface 4.2.0 → 4.5.0-beta.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": "4.2.0",
3
+ "version": "4.5.0-beta.0",
4
4
  "description": "Typescript library containing resources that facilitate integration with SearchApi",
5
5
  "main": "index.js",
6
6
  "scripts": {
@@ -1,7 +1,12 @@
1
1
  import { DegreeTypeEnum } from "./DegreeTypeEnum";
2
2
  import { DeliveryMethodEnum } from "./DeliveryMethodEnum";
3
+ import { FacetFilterType } from "../enums";
3
4
  export declare class IOrganisationSearchFilters {
5
+ /**
6
+ * @deprecated Use organisationIds instead.
7
+ */
4
8
  readonly organisationId: string | undefined;
9
+ readonly organisationIds: string[] | undefined;
5
10
  readonly organisationText: string | undefined;
6
11
  readonly degree: DegreeTypeEnum | undefined;
7
12
  readonly disciplines: string[] | undefined;
@@ -13,5 +18,6 @@ export declare class IOrganisationSearchFilters {
13
18
  readonly cityIds: string[] | undefined;
14
19
  readonly virtualPath: string | undefined;
15
20
  readonly cityIdsOfMainLocation: string[] | undefined;
21
+ readonly facets: FacetFilterType[] | undefined;
16
22
  readonly showHidden: boolean | undefined;
17
23
  }
@@ -1,5 +1,9 @@
1
1
  export class IOrganisationSearchFilters {
2
+ /**
3
+ * @deprecated Use organisationIds instead.
4
+ */
2
5
  organisationId;
6
+ organisationIds;
3
7
  organisationText;
4
8
  degree;
5
9
  disciplines;
@@ -11,6 +15,7 @@ export class IOrganisationSearchFilters {
11
15
  cityIds;
12
16
  virtualPath;
13
17
  cityIdsOfMainLocation;
18
+ facets;
14
19
  showHidden;
15
20
  }
16
21
  //# sourceMappingURL=IOrganisationSearchFilters.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"IOrganisationSearchFilters.js","sourceRoot":"","sources":["../../../src/organisations/IOrganisationSearchFilters.ts"],"names":[],"mappings":"AAGA,MAAM,OAAO,0BAA0B;IAC7B,cAAc,CAAqB;IACnC,gBAAgB,CAAqB;IACrC,MAAM,CAA6B;IACnC,WAAW,CAAuB;IAClC,eAAe,CAAmC;IAClD,eAAe,CAAuB;IACtC,8BAA8B,CAAuB;IACrD,SAAS,CAAuB;IAChC,OAAO,CAAuB;IAC9B,OAAO,CAAuB;IAC9B,WAAW,CAAqB;IAChC,qBAAqB,CAAuB;IAC5C,UAAU,CAAsB;CACzC"}
1
+ {"version":3,"file":"IOrganisationSearchFilters.js","sourceRoot":"","sources":["../../../src/organisations/IOrganisationSearchFilters.ts"],"names":[],"mappings":"AAIA,MAAM,OAAO,0BAA0B;IACtC;;OAEG;IACM,cAAc,CAAqB;IACnC,eAAe,CAAuB;IACtC,gBAAgB,CAAqB;IACrC,MAAM,CAA6B;IACnC,WAAW,CAAuB;IAClC,eAAe,CAAmC;IAClD,eAAe,CAAuB;IACtC,8BAA8B,CAAuB;IACrD,SAAS,CAAuB;IAChC,OAAO,CAAuB;IAC9B,OAAO,CAAuB;IAC9B,WAAW,CAAqB;IAChC,qBAAqB,CAAuB;IAC5C,MAAM,CAAgC;IACtC,UAAU,CAAsB;CACzC"}
@@ -1,6 +1,8 @@
1
1
  import { HitsTotalRelation } from "../HitsTotalRelation";
2
+ import { FacetResponseType } from "../facets/FacetResponseType";
2
3
  export interface IOrganisationSearchResponse<T> {
3
4
  readonly organisations: readonly T[];
4
5
  readonly hitsTotal: number;
5
6
  readonly hitsTotalRelation: HitsTotalRelation;
7
+ readonly facets?: readonly FacetResponseType[];
6
8
  }
@@ -2,8 +2,13 @@ import { DegreeTypeEnum } from "./DegreeTypeEnum";
2
2
  import { DeliveryMethodEnum } from "./DeliveryMethodEnum";
3
3
  import { OrganisationSearchInput } from "./OrganisationSearchInput";
4
4
  import { IOrganisationSearchFilters } from "./IOrganisationSearchFilters";
5
+ import { FacetFilterType } from "../enums";
5
6
  export declare class OrganisationSearchFilters implements IOrganisationSearchFilters {
7
+ /**
8
+ * @deprecated Use organisationIds instead.
9
+ */
6
10
  organisationId: string | undefined;
11
+ organisationIds: string[] | undefined;
7
12
  degree: DegreeTypeEnum | undefined;
8
13
  disciplines: string[] | undefined;
9
14
  deliveryMethods: DeliveryMethodEnum[] | undefined;
@@ -14,6 +19,7 @@ export declare class OrganisationSearchFilters implements IOrganisationSearchFil
14
19
  cityIds: string[] | undefined;
15
20
  cityIdsOfMainLocation: string[] | undefined;
16
21
  virtualPath: string | undefined;
22
+ facets: FacetFilterType[] | undefined;
17
23
  showHidden: boolean | undefined;
18
24
  organisationText: string | undefined;
19
25
  from(input: OrganisationSearchInput): OrganisationSearchFilters;
@@ -1,5 +1,9 @@
1
1
  export class OrganisationSearchFilters {
2
+ /**
3
+ * @deprecated Use organisationIds instead.
4
+ */
2
5
  organisationId;
6
+ organisationIds;
3
7
  degree;
4
8
  disciplines;
5
9
  deliveryMethods;
@@ -10,10 +14,12 @@ export class OrganisationSearchFilters {
10
14
  cityIds;
11
15
  cityIdsOfMainLocation;
12
16
  virtualPath;
17
+ facets;
13
18
  showHidden;
14
19
  organisationText;
15
20
  from(input) {
16
21
  this.organisationId = input.organisationId ? input.organisationId.toString() : undefined;
22
+ this.organisationIds = this.numbersToStringsOrUndefined(input.organisationIds);
17
23
  this.organisationText = input.organisationText;
18
24
  this.degree = input.degree;
19
25
  this.deliveryMethods = input.deliveryMethods;
@@ -25,6 +31,7 @@ export class OrganisationSearchFilters {
25
31
  this.cityIds = this.numbersToStringsOrUndefined(input.cityIds);
26
32
  this.virtualPath = input.virtualPath;
27
33
  this.cityIdsOfMainLocation = input.cityIdsOfMainLocation;
34
+ this.facets = input.facets;
28
35
  this.showHidden = input.showHidden;
29
36
  return this;
30
37
  }
@@ -1 +1 @@
1
- {"version":3,"file":"OrganisationSearchFilters.js","sourceRoot":"","sources":["../../../src/organisations/OrganisationSearchFilters.ts"],"names":[],"mappings":"AAKA,MAAM,OAAO,yBAAyB;IAC9B,cAAc,CAAqB;IACnC,MAAM,CAA6B;IACnC,WAAW,CAAuB;IAClC,eAAe,CAAmC;IAClD,eAAe,CAAuB;IACtC,8BAA8B,CAAuB;IACrD,SAAS,CAAuB;IAChC,OAAO,CAAuB;IAC9B,OAAO,CAAuB;IAC9B,qBAAqB,CAAuB;IAC5C,WAAW,CAAqB;IAChC,UAAU,CAAsB;IAChC,gBAAgB,CAAqB;IAErC,IAAI,CAAC,KAA8B;QACzC,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACzF,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAC/C,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;QAC7C,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACvE,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;QAC7C,IAAI,CAAC,8BAA8B,GAAG,KAAK,CAAC,8BAA8B,CAAC;QAC3E,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACnE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC,qBAAqB,CAAC;QACzD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QAEnC,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,aAAa,CAAC,EAAU;QAC9B,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,iBAAiB,CAAC,MAAsB;QAC9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,sBAAsB,CAAC,WAAqB;QAClD,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,0BAA0B,CAAC,eAAqC;QACtE,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,0BAA0B,CAAC,eAAyB;QAC1D,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,yCAAyC,CAAC,eAAyB;QACzE,IAAI,CAAC,8BAA8B,GAAG,eAAe,CAAC;QACtD,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,oBAAoB,CAAC,SAAmB;QAC9C,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,kBAAkB,CAAC,OAAiB;QAC1C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,kBAAkB,CAAC,OAAiB;QAC1C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,gCAAgC,CAAC,qBAA+B;QACtE,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;QACnD,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,sBAAsB,CAAC,WAAmB;QAChD,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,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"}
1
+ {"version":3,"file":"OrganisationSearchFilters.js","sourceRoot":"","sources":["../../../src/organisations/OrganisationSearchFilters.ts"],"names":[],"mappings":"AAMA,MAAM,OAAO,yBAAyB;IACrC;;OAEG;IACI,cAAc,CAAqB;IACnC,eAAe,CAAuB;IACtC,MAAM,CAA6B;IACnC,WAAW,CAAuB;IAClC,eAAe,CAAmC;IAClD,eAAe,CAAuB;IACtC,8BAA8B,CAAuB;IACrD,SAAS,CAAuB;IAChC,OAAO,CAAuB;IAC9B,OAAO,CAAuB;IAC9B,qBAAqB,CAAuB;IAC5C,WAAW,CAAqB;IAChC,MAAM,CAAgC;IACtC,UAAU,CAAsB;IAChC,gBAAgB,CAAqB;IAErC,IAAI,CAAC,KAA8B;QACzC,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACzF,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAC/E,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAC/C,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;QAC7C,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACvE,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;QAC7C,IAAI,CAAC,8BAA8B,GAAG,KAAK,CAAC,8BAA8B,CAAC;QAC3E,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACnE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC,qBAAqB,CAAC;QACzD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QAEnC,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,aAAa,CAAC,EAAU;QAC9B,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,iBAAiB,CAAC,MAAsB;QAC9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,sBAAsB,CAAC,WAAqB;QAClD,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,0BAA0B,CAAC,eAAqC;QACtE,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,0BAA0B,CAAC,eAAyB;QAC1D,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,yCAAyC,CAAC,eAAyB;QACzE,IAAI,CAAC,8BAA8B,GAAG,eAAe,CAAC;QACtD,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,oBAAoB,CAAC,SAAmB;QAC9C,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,kBAAkB,CAAC,OAAiB;QAC1C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,kBAAkB,CAAC,OAAiB;QAC1C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,gCAAgC,CAAC,qBAA+B;QACtE,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;QACnD,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,sBAAsB,CAAC,WAAmB;QAChD,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,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"}
@@ -1,9 +1,14 @@
1
1
  import { DegreeTypeEnum } from "./DegreeTypeEnum";
2
2
  import { DeliveryMethodEnum } from "./DeliveryMethodEnum";
3
+ import { FacetFilterType } from "../enums";
3
4
  export type OrganisationSearchInput = {
4
5
  resultSize: number;
5
6
  resultOffset: number;
7
+ /**
8
+ * @deprecated Use organisationIds instead.
9
+ */
6
10
  organisationId?: number;
11
+ organisationIds?: number[];
7
12
  organisationText?: string;
8
13
  disciplines?: number[];
9
14
  countryIsoCodes?: string[];
@@ -15,5 +20,6 @@ export type OrganisationSearchInput = {
15
20
  degree?: DegreeTypeEnum;
16
21
  deliveryMethods?: DeliveryMethodEnum[];
17
22
  virtualPath?: string;
23
+ facets?: FacetFilterType[];
18
24
  showHidden?: boolean;
19
25
  };