@studyportals/search-api-interface 4.0.1 → 4.1.0-beta.1

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.
Files changed (11) hide show
  1. package/package.json +31 -31
  2. package/src/enums/InsightFilterType.d.ts +7 -0
  3. package/src/enums/InsightFilterType.js +9 -0
  4. package/src/enums/InsightFilterType.js.map +1 -0
  5. package/src/enums/index.d.ts +1 -0
  6. package/src/enums/index.js +1 -0
  7. package/src/enums/index.js.map +1 -1
  8. package/src/programmes/ProgrammeSearchFilters.d.ts +2 -1
  9. package/src/programmes/ProgrammeSearchFilters.js +2 -0
  10. package/src/programmes/ProgrammeSearchFilters.js.map +1 -1
  11. package/src/programmes/ProgrammeSearchInput.d.ts +2 -1
package/package.json CHANGED
@@ -1,31 +1,31 @@
1
- {
2
- "name": "@studyportals/search-api-interface",
3
- "version": "4.0.1",
4
- "description": "Typescript library containing resources that facilitate integration with SearchApi",
5
- "main": "index.js",
6
- "scripts": {
7
- "compile": "rm -fR bin && npx tsc",
8
- "deploy-patch": "npm version patch && npm run deploy",
9
- "deploy-minor": "npm version minor && npm run deploy",
10
- "deploy-major": "npm version major && npm run deploy",
11
- "deploy-beta": "npm version prerelease && npm run prepare-deployment && npm publish ./bin --tag beta",
12
- "deploy": "npm run prepare-deployment && npm publish ./bin",
13
- "prepare-deployment": "npm run compile && cp package.json bin/package.json",
14
- "lint": "eslint . --ext .ts",
15
- "lint:fix": "eslint . --ext .ts --fix"
16
- },
17
- "author": "Seal Team Six",
18
- "license": "BSD-3-Clause",
19
- "devDependencies": {
20
- "@studyportals/code-style": "^1.7.0",
21
- "@types/superagent": "^4.1.15",
22
- "@typescript-eslint/eslint-plugin": "^5.27.0",
23
- "@typescript-eslint/parser": "^5.27.0",
24
- "eslint": "^8.17.0",
25
- "typescript": "^5.5.4",
26
- "typescript-transform-paths": "^3.4.6"
27
- },
28
- "dependencies": {
29
- "@studyportals/domain-client": "^7.6.9"
30
- }
31
- }
1
+ {
2
+ "name": "@studyportals/search-api-interface",
3
+ "version": "4.1.0-beta.1",
4
+ "description": "Typescript library containing resources that facilitate integration with SearchApi",
5
+ "main": "index.js",
6
+ "scripts": {
7
+ "compile": "rm -fR bin && npx tsc",
8
+ "deploy-patch": "npm version patch && npm run deploy",
9
+ "deploy-minor": "npm version minor && npm run deploy",
10
+ "deploy-major": "npm version major && npm run deploy",
11
+ "deploy-beta": "npm run prepare-deployment && npm publish ./bin --tag beta",
12
+ "deploy": "npm run prepare-deployment && npm publish ./bin",
13
+ "prepare-deployment": "npm run compile && cp package.json bin/package.json",
14
+ "lint": "eslint . --ext .ts",
15
+ "lint:fix": "eslint . --ext .ts --fix"
16
+ },
17
+ "author": "Seal Team Six",
18
+ "license": "BSD-3-Clause",
19
+ "devDependencies": {
20
+ "@studyportals/code-style": "^1.7.0",
21
+ "@types/superagent": "^4.1.15",
22
+ "@typescript-eslint/eslint-plugin": "^5.27.0",
23
+ "@typescript-eslint/parser": "^5.27.0",
24
+ "eslint": "^8.17.0",
25
+ "typescript": "^5.5.4",
26
+ "typescript-transform-paths": "^3.4.6"
27
+ },
28
+ "dependencies": {
29
+ "@studyportals/domain-client": "^7.6.9"
30
+ }
31
+ }
package/src/enums/InsightFilterType.d.ts ADDED
@@ -0,0 +1,7 @@
1
+ export declare enum InsightFilterType {
2
+ PERCENTAGE_ONLINE_STUDIES = "percentageOnlineStudies",
3
+ AVERAGE_INTERNATIONAL_TUITION_FEE = "averageInternationalTuitionFeeInEur",
4
+ MIN_INTERNATIONAL_TUITION_FEE = "minInternationalTuitionFeeInEur",
5
+ MAX_INTERNATIONAL_TUITION_FEE = "maxInternationalTuitionFeeInEur",
6
+ PERCENTAGE_AFFORDABLE_INTERNATIONAL_TUITION = "percentageAffordableInternationalTuitionInEur"
7
+ }
package/src/enums/InsightFilterType.js ADDED
@@ -0,0 +1,9 @@
1
+ export var InsightFilterType;
2
+ (function (InsightFilterType) {
3
+ InsightFilterType["PERCENTAGE_ONLINE_STUDIES"] = "percentageOnlineStudies";
4
+ InsightFilterType["AVERAGE_INTERNATIONAL_TUITION_FEE"] = "averageInternationalTuitionFeeInEur";
5
+ InsightFilterType["MIN_INTERNATIONAL_TUITION_FEE"] = "minInternationalTuitionFeeInEur";
6
+ InsightFilterType["MAX_INTERNATIONAL_TUITION_FEE"] = "maxInternationalTuitionFeeInEur";
7
+ InsightFilterType["PERCENTAGE_AFFORDABLE_INTERNATIONAL_TUITION"] = "percentageAffordableInternationalTuitionInEur";
8
+ })(InsightFilterType || (InsightFilterType = {}));
9
+ //# sourceMappingURL=InsightFilterType.js.map
package/src/enums/InsightFilterType.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"InsightFilterType.js","sourceRoot":"","sources":["../../../src/enums/InsightFilterType.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,iBAMX;AAND,WAAY,iBAAiB;IAC5B,0EAAqD,CAAA;IACrD,8FAAyE,CAAA;IACzE,sFAAiE,CAAA;IACjE,sFAAiE,CAAA;IACjE,kHAA6F,CAAA;AAC9F,CAAC,EANW,iBAAiB,KAAjB,iBAAiB,QAM5B"}
package/src/enums/index.d.ts CHANGED
@@ -4,6 +4,7 @@ export * from "./DurationFilterValue";
4
4
  export * from "./EducationalFormFilterValue";
5
5
  export * from "./EducationLevelFilterValue";
6
6
  export * from "./FacetFilterType";
7
+ export * from "./InsightFilterType";
7
8
  export * from "./DensitiesFilterValue";
8
9
  export * from "./SpecialProgrammesFilterValue";
9
10
  export * from "./TuitionFeeFilterValue";
package/src/enums/index.js CHANGED
@@ -4,6 +4,7 @@ export * from "./DurationFilterValue";
4
4
  export * from "./EducationalFormFilterValue";
5
5
  export * from "./EducationLevelFilterValue";
6
6
  export * from "./FacetFilterType";
7
+ export * from "./InsightFilterType";
7
8
  export * from "./DensitiesFilterValue";
8
9
  export * from "./SpecialProgrammesFilterValue";
9
10
  export * from "./TuitionFeeFilterValue";
package/src/enums/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/enums/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,yBAAyB,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/enums/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,yBAAyB,CAAC"}
package/src/programmes/ProgrammeSearchFilters.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { IProgrammeSearchFilters } from "./IProgrammeSearchFilters";
2
2
  import { ProgrammeSearchInput } from "./ProgrammeSearchInput";
3
- import { AttendanceFilterValue, DegreeTypeFilterValue, DurationFilterValue, EducationalFormFilterValue, EducationLevelFilterValue, DensitiesFilterValue, SpecialProgrammesFilterValue, FacetFilterType } from "../enums";
3
+ import { AttendanceFilterValue, DegreeTypeFilterValue, DurationFilterValue, EducationalFormFilterValue, EducationLevelFilterValue, DensitiesFilterValue, SpecialProgrammesFilterValue, FacetFilterType, InsightFilterType } from "../enums";
4
4
  import { ProgrammeSortType } from "./ProgrammeSortType";
5
5
  import { TextSearchAlgorithmType } from "../TextSearchAlgorithmType";
6
6
  import { ProgrammeCardType } from "./ProgrammeCardType";
@@ -25,6 +25,7 @@ export declare class ProgrammeSearchFilters implements IProgrammeSearchFilters {
25
25
  suggestionSize?: number;
26
26
  facets?: FacetFilterType[];
27
27
  facetsDurations?: DurationFilterValue[];
28
+ insights?: InsightFilterType[];
28
29
  cardType?: ProgrammeCardType;
29
30
  textSearchAlgorithm?: TextSearchAlgorithmType;
30
31
  showHidden?: boolean;
package/src/programmes/ProgrammeSearchFilters.js CHANGED
@@ -20,6 +20,7 @@ export class ProgrammeSearchFilters {
20
20
  suggestionSize;
21
21
  facets;
22
22
  facetsDurations;
23
+ insights;
23
24
  cardType;
24
25
  textSearchAlgorithm;
25
26
  showHidden;
@@ -45,6 +46,7 @@ export class ProgrammeSearchFilters {
45
46
  this.suggestionSize = input.suggestionSize;
46
47
  this.facets = input.facets;
47
48
  this.facetsDurations = input.facetsDurations;
49
+ this.insights = input.insights;
48
50
  this.cardType = input.cardType;
49
51
  this.textSearchAlgorithm = input.textSearchAlgorithm;
50
52
  this.showHidden = input.showHidden;
package/src/programmes/ProgrammeSearchFilters.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ProgrammeSearchFilters.js","sourceRoot":"","sources":["../../../src/programmes/ProgrammeSearchFilters.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAIxD,MAAM,OAAO,sBAAsB;IAC3B,WAAW,CAA2B;IACtC,WAAW,CAA2B;IACtC,WAAW,CAAY;IACvB,SAAS,CAAyB;IAClC,iBAAiB,CAA+B;IAChD,gBAAgB,CAAgC;IAEhD,SAAS,CAA0B;IAEnC,IAAI,CAAU;IAEd,OAAO,CAAY;IACnB,SAAS,CAAY;IACrB,eAAe,CAAY;IAC3B,eAAe,CAAY;IAE3B,iBAAiB,CAAkC;IAEnD,aAAa,CAAU;IACvB,aAAa,CAAU;IAEvB,qBAAqB,CAAU;IAE/B,MAAM,CAAoB;IAE1B,cAAc,CAAU;IACxB,MAAM,CAAqB;IAC3B,eAAe,CAAyB;IAExC,QAAQ,CAAoB;IAC5B,mBAAmB,CAA2B;IAC9C,UAAU,CAAW;IACrB,aAAa,CAAY;IAEzB,IAAI,CAAC,KAA2B;QACtC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACvE,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QACjD,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QAEjC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QAEvB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACnE,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;QAE7C,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1G,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QACjD,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC,qBAAqB,CAAC;QAEzD,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC;QACzC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC;QAEzC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,iBAAiB,CAAC,OAAO,CAAC;QAExD,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC;QAC3C,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;QAE7C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,mBAAmB,CAAC;QACrD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QACnC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC;QAEzC,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":"ProgrammeSearchFilters.js","sourceRoot":"","sources":["../../../src/programmes/ProgrammeSearchFilters.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAIxD,MAAM,OAAO,sBAAsB;IAC3B,WAAW,CAA2B;IACtC,WAAW,CAA2B;IACtC,WAAW,CAAY;IACvB,SAAS,CAAyB;IAClC,iBAAiB,CAA+B;IAChD,gBAAgB,CAAgC;IAEhD,SAAS,CAA0B;IAEnC,IAAI,CAAU;IAEd,OAAO,CAAY;IACnB,SAAS,CAAY;IACrB,eAAe,CAAY;IAC3B,eAAe,CAAY;IAE3B,iBAAiB,CAAkC;IAEnD,aAAa,CAAU;IACvB,aAAa,CAAU;IAEvB,qBAAqB,CAAU;IAE/B,MAAM,CAAoB;IAE1B,cAAc,CAAU;IACxB,MAAM,CAAqB;IAC3B,eAAe,CAAyB;IAExC,QAAQ,CAAuB;IAE/B,QAAQ,CAAoB;IAC5B,mBAAmB,CAA2B;IAC9C,UAAU,CAAW;IACrB,aAAa,CAAY;IAEzB,IAAI,CAAC,KAA2B;QACtC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACvE,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QACjD,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QAEjC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QAEvB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACnE,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;QAE7C,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1G,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QACjD,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC,qBAAqB,CAAC;QAEzD,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC;QACzC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC;QAEzC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,iBAAiB,CAAC,OAAO,CAAC;QAExD,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC;QAC3C,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;QAE7C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAE/B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,mBAAmB,CAAC;QACrD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QACnC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC;QAEzC,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"}
package/src/programmes/ProgrammeSearchInput.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import { ProgrammeSortType } from "./ProgrammeSortType";
2
2
  import { TextSearchAlgorithmType } from "../TextSearchAlgorithmType";
3
3
  import { ProgrammeCardType } from "./ProgrammeCardType";
4
- import { AttendanceFilterValue, DegreeTypeFilterValue, DurationFilterValue, EducationalFormFilterValue, EducationLevelFilterValue, DensitiesFilterValue, SpecialProgrammesFilterValue, FacetFilterType } from "../enums";
4
+ import { AttendanceFilterValue, DegreeTypeFilterValue, DurationFilterValue, EducationalFormFilterValue, EducationLevelFilterValue, DensitiesFilterValue, SpecialProgrammesFilterValue, FacetFilterType, InsightFilterType } from "../enums";
5
5
  export type ProgrammeSearchInput = {
6
6
  attendances?: AttendanceFilterValue[];
7
7
  degreeTypes?: DegreeTypeFilterValue[];
@@ -23,6 +23,7 @@ export type ProgrammeSearchInput = {
23
23
  suggestionSize?: number;
24
24
  facets?: FacetFilterType[];
25
25
  facetsDurations?: DurationFilterValue[];
26
+ insights?: InsightFilterType[];
26
27
  cardType?: ProgrammeCardType;
27
28
  textSearchAlgorithm?: TextSearchAlgorithmType;
28
29
  campaignTypes?: string[];