@studyportals/domain-client 8.2.0 → 8.2.1-beta.3
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 +1 -2
- package/package.json +68 -68
- package/src/models/organisation-card/i-organisation-card.d.ts +0 -3
- package/src/models/organisation-search-document/i-organisation-search-document.d.ts +12 -0
- package/src/models/organisation-card/i-ranking-discipline.d.ts +0 -4
- package/src/models/organisation-card/i-ranking-discipline.js +0 -1
package/index.d.ts
CHANGED
|
@@ -56,7 +56,6 @@ import { CustomerIOOrganisationClient } from "./src/models/customerio-organisati
|
|
|
56
56
|
import { ISitemapOrganisationInfo } from "./src/models/sitemap-organisations-info/i-sitemap-organisation-info.js";
|
|
57
57
|
import { SitemapOrganisationsInfoClient } from "./src/models/sitemap-organisations-info/sitemap-organisations-info-client.js";
|
|
58
58
|
import { IOrganisationCard } from "./src/models/organisation-card/i-organisation-card.js";
|
|
59
|
-
import { IRankingDiscipline } from "./src/models/organisation-card/i-ranking-discipline.js";
|
|
60
59
|
import { OrganisationCardClient } from "./src/models/organisation-card/organisation-card-client.js";
|
|
61
60
|
import { IOrganisationSearchDocument } from "./src/models/organisation-search-document/i-organisation-search-document.js";
|
|
62
61
|
import { OrganisationSearchDocumentClient } from "./src/models/organisation-search-document/organisation-search-document-client.js";
|
|
@@ -84,6 +83,6 @@ import { CopilotCountryClient } from "./src/models/copilot-country/copilot-count
|
|
|
84
83
|
import { ICopilotRankingCard } from "./src/models/copilot-country/i-copilot-ranking-card.js";
|
|
85
84
|
import { IReviewRating } from "./src/models/common/i-review-rating.js";
|
|
86
85
|
import { IScholarshipCard } from "./src/models/scholarship-card/i-scholarship-card.js";
|
|
87
|
-
export { BadRequestException, ClientException, InternalServerException, NotFoundException, PropertyNotAvailableException, ICover, ILink, IOptionalLink, ILocation, IClickTrackingData, ITracking, IDuration, IDeadline, IStartDate, ITiming, ITrackedLink, IProgrammeCard, ProgrammeCardClient, ITuitionValues, IPremiumValues, IOrganisationValues, IGeoTargetingConfiguration, IGeoTargetingValues, ISearchProjection, SearchProjectionClient, ILivingCost, IGPARequirement, IBestFitProgramme, BestfitProgrammeClient, ILogo, ITuitionFee, IEnglishRequirements, IInternalLink, ICustomerIOProgramme, CustomerIOProgrammeClient, IFaqStaticContent, PublicFaqStaticContentClient, IFaq, IStaticContentUrl, ISitemapProgrammeInfo, SitemapProgrammeInfoClient, ISitemapCountryInfo, SitemapCountriesInfoClient, IDegreeInfo, ISitemapCountryDegreeInfo, SitemapCountryDegreeInfoClient, ISearchDiscipline, PublicSearchDisciplineClient, ISitemapDisciplineInfo, SitemapDisciplinesInfoClient, ICountry, ICity, IReview, ICustomerIOOrganisation, CustomerIOOrganisationClient, ISitemapOrganisationInfo, SitemapOrganisationsInfoClient, IOrganisationSearchDocument, OrganisationSearchDocumentClient, ISitemapRankingsInfo, SitemapRankingsInfoClient, ISitemapArticleInfo, SitemapArticlesInfoClient, ISitemapCityInfo, SitemapCitiesInfoClient, ScholarshipCardV2Client, IScholarshipCard, IScholarshipSearchDocument, ScholarshipSearchDocumentClient, ICitySearchDocument, CitySearchDocumentClient, IRanking, PortalType, PortalMap, ModelClient, IOrganisationForSearch, PublicOrganisationForSearchClient, IOrganisationCard,
|
|
86
|
+
export { BadRequestException, ClientException, InternalServerException, NotFoundException, PropertyNotAvailableException, ICover, ILink, IOptionalLink, ILocation, IClickTrackingData, ITracking, IDuration, IDeadline, IStartDate, ITiming, ITrackedLink, IProgrammeCard, ProgrammeCardClient, ITuitionValues, IPremiumValues, IOrganisationValues, IGeoTargetingConfiguration, IGeoTargetingValues, ISearchProjection, SearchProjectionClient, ILivingCost, IGPARequirement, IBestFitProgramme, BestfitProgrammeClient, ILogo, ITuitionFee, IEnglishRequirements, IInternalLink, ICustomerIOProgramme, CustomerIOProgrammeClient, IFaqStaticContent, PublicFaqStaticContentClient, IFaq, IStaticContentUrl, ISitemapProgrammeInfo, SitemapProgrammeInfoClient, ISitemapCountryInfo, SitemapCountriesInfoClient, IDegreeInfo, ISitemapCountryDegreeInfo, SitemapCountryDegreeInfoClient, ISearchDiscipline, PublicSearchDisciplineClient, ISitemapDisciplineInfo, SitemapDisciplinesInfoClient, ICountry, ICity, IReview, ICustomerIOOrganisation, CustomerIOOrganisationClient, ISitemapOrganisationInfo, SitemapOrganisationsInfoClient, IOrganisationSearchDocument, OrganisationSearchDocumentClient, ISitemapRankingsInfo, SitemapRankingsInfoClient, ISitemapArticleInfo, SitemapArticlesInfoClient, ISitemapCityInfo, SitemapCitiesInfoClient, ScholarshipCardV2Client, IScholarshipCard, IScholarshipSearchDocument, ScholarshipSearchDocumentClient, ICitySearchDocument, CitySearchDocumentClient, IRanking, PortalType, PortalMap, ModelClient, IOrganisationForSearch, PublicOrganisationForSearchClient, IOrganisationCard, OrganisationCardClient, ICopilotProgramme, ICopilotCountry, CopilotProgrammeClient, CopilotCountryClient, ICopilotRankingCard, IReviewRating };
|
|
88
87
|
export * from './src/clients/index.js';
|
|
89
88
|
export * from './protobuf/index.js';
|
package/package.json
CHANGED
|
@@ -1,68 +1,68 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@studyportals/domain-client",
|
|
3
|
-
"version": "8.2.
|
|
4
|
-
"description": "Responsible for fetching data from the Domain API",
|
|
5
|
-
"type": "module",
|
|
6
|
-
"main": "index.js",
|
|
7
|
-
"module": "index.js",
|
|
8
|
-
"types": "index.d.ts",
|
|
9
|
-
"exports": {
|
|
10
|
-
".": {
|
|
11
|
-
"types": "./index.d.ts",
|
|
12
|
-
"require": "./index.js",
|
|
13
|
-
"import": "./index.js",
|
|
14
|
-
"default": "./index.js"
|
|
15
|
-
},
|
|
16
|
-
"./protobuf": {
|
|
17
|
-
"types": "./protobuf/index.d.ts",
|
|
18
|
-
"require": "./protobuf/index.js",
|
|
19
|
-
"import": "./protobuf/index.js",
|
|
20
|
-
"default": "./protobuf/index.js"
|
|
21
|
-
}
|
|
22
|
-
},
|
|
23
|
-
"author": "StudyPortals B.V.",
|
|
24
|
-
"sideEffects": false,
|
|
25
|
-
"contributors": [
|
|
26
|
-
"braaibander <danny@studyportals.com>"
|
|
27
|
-
],
|
|
28
|
-
"license": "BSD-3-Clause",
|
|
29
|
-
"scripts": {
|
|
30
|
-
"build": "tsc",
|
|
31
|
-
"test": "vitest run",
|
|
32
|
-
"test:watch": "vitest",
|
|
33
|
-
"coverage": "vitest run --coverage",
|
|
34
|
-
"lint": "eslint . --ext .ts --max-warnings=0",
|
|
35
|
-
"lint:fix": "eslint . --ext .ts --fix",
|
|
36
|
-
"pre-push": "npm run test && npm run coverage && npm run lint",
|
|
37
|
-
"prepare-dist": "npm run test && rm -fR bin && npx tsc && npx tsc-alias -p tsconfig.json --outDir bin -f && cp package.json bin/package.json && rm -fR bin/tests",
|
|
38
|
-
"publish-beta": "npm version prerelease --preid=beta && npm run prepare-dist && npm publish ./bin --tag beta",
|
|
39
|
-
"publish-major": "npm version major && npm run prepare-dist && npm publish ./bin",
|
|
40
|
-
"publish-minor": "npm version minor && npm run prepare-dist && npm publish ./bin",
|
|
41
|
-
"publish-patch": "npm version patch && npm run prepare-dist && npm publish ./bin",
|
|
42
|
-
"publish-current": "npm run prepare-dist && npm publish ./bin"
|
|
43
|
-
},
|
|
44
|
-
"husky": {
|
|
45
|
-
"hooks": {
|
|
46
|
-
"pre-push": "npm run pre-push"
|
|
47
|
-
}
|
|
48
|
-
},
|
|
49
|
-
"devDependencies": {
|
|
50
|
-
"@studyportals/code-style": "^2.0.4",
|
|
51
|
-
"@types/node": "^24.2.1",
|
|
52
|
-
"@types/reflect-metadata": "^0.1.0",
|
|
53
|
-
"@typescript-eslint/eslint-plugin": "^4.8.1",
|
|
54
|
-
"@typescript-eslint/parser": "^4.8.1",
|
|
55
|
-
"@vitest/coverage-v8": "^3.2.4",
|
|
56
|
-
"eslint": "^7.13.0",
|
|
57
|
-
"eslint-plugin-import": "^2.22.1",
|
|
58
|
-
"eslint-plugin-mocha": "^10.1.0",
|
|
59
|
-
"husky": "^4.3.0",
|
|
60
|
-
"nyc": "^15.1.0",
|
|
61
|
-
"source-map-support": "^0.5.19",
|
|
62
|
-
"tsc-alias": "^1.8.16",
|
|
63
|
-
"tslint": "^6.1.3",
|
|
64
|
-
"typemoq": "^2.1.0",
|
|
65
|
-
"typescript": "^5.9.2",
|
|
66
|
-
"vitest": "^3.2.4"
|
|
67
|
-
}
|
|
68
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "@studyportals/domain-client",
|
|
3
|
+
"version": "8.2.1-beta.3",
|
|
4
|
+
"description": "Responsible for fetching data from the Domain API",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "index.js",
|
|
7
|
+
"module": "index.js",
|
|
8
|
+
"types": "index.d.ts",
|
|
9
|
+
"exports": {
|
|
10
|
+
".": {
|
|
11
|
+
"types": "./index.d.ts",
|
|
12
|
+
"require": "./index.js",
|
|
13
|
+
"import": "./index.js",
|
|
14
|
+
"default": "./index.js"
|
|
15
|
+
},
|
|
16
|
+
"./protobuf": {
|
|
17
|
+
"types": "./protobuf/index.d.ts",
|
|
18
|
+
"require": "./protobuf/index.js",
|
|
19
|
+
"import": "./protobuf/index.js",
|
|
20
|
+
"default": "./protobuf/index.js"
|
|
21
|
+
}
|
|
22
|
+
},
|
|
23
|
+
"author": "StudyPortals B.V.",
|
|
24
|
+
"sideEffects": false,
|
|
25
|
+
"contributors": [
|
|
26
|
+
"braaibander <danny@studyportals.com>"
|
|
27
|
+
],
|
|
28
|
+
"license": "BSD-3-Clause",
|
|
29
|
+
"scripts": {
|
|
30
|
+
"build": "tsc",
|
|
31
|
+
"test": "vitest run",
|
|
32
|
+
"test:watch": "vitest",
|
|
33
|
+
"coverage": "vitest run --coverage",
|
|
34
|
+
"lint": "eslint . --ext .ts --max-warnings=0",
|
|
35
|
+
"lint:fix": "eslint . --ext .ts --fix",
|
|
36
|
+
"pre-push": "npm run test && npm run coverage && npm run lint",
|
|
37
|
+
"prepare-dist": "npm run test && rm -fR bin && npx tsc && npx tsc-alias -p tsconfig.json --outDir bin -f && cp package.json bin/package.json && rm -fR bin/tests",
|
|
38
|
+
"publish-beta": "npm version prerelease --preid=beta && npm run prepare-dist && npm publish ./bin --tag beta",
|
|
39
|
+
"publish-major": "npm version major && npm run prepare-dist && npm publish ./bin",
|
|
40
|
+
"publish-minor": "npm version minor && npm run prepare-dist && npm publish ./bin",
|
|
41
|
+
"publish-patch": "npm version patch && npm run prepare-dist && npm publish ./bin",
|
|
42
|
+
"publish-current": "npm run prepare-dist && npm publish ./bin"
|
|
43
|
+
},
|
|
44
|
+
"husky": {
|
|
45
|
+
"hooks": {
|
|
46
|
+
"pre-push": "npm run pre-push"
|
|
47
|
+
}
|
|
48
|
+
},
|
|
49
|
+
"devDependencies": {
|
|
50
|
+
"@studyportals/code-style": "^2.0.4",
|
|
51
|
+
"@types/node": "^24.2.1",
|
|
52
|
+
"@types/reflect-metadata": "^0.1.0",
|
|
53
|
+
"@typescript-eslint/eslint-plugin": "^4.8.1",
|
|
54
|
+
"@typescript-eslint/parser": "^4.8.1",
|
|
55
|
+
"@vitest/coverage-v8": "^3.2.4",
|
|
56
|
+
"eslint": "^7.13.0",
|
|
57
|
+
"eslint-plugin-import": "^2.22.1",
|
|
58
|
+
"eslint-plugin-mocha": "^10.1.0",
|
|
59
|
+
"husky": "^4.3.0",
|
|
60
|
+
"nyc": "^15.1.0",
|
|
61
|
+
"source-map-support": "^0.5.19",
|
|
62
|
+
"tsc-alias": "^1.8.16",
|
|
63
|
+
"tslint": "^6.1.3",
|
|
64
|
+
"typemoq": "^2.1.0",
|
|
65
|
+
"typescript": "^5.9.2",
|
|
66
|
+
"vitest": "^3.2.4"
|
|
67
|
+
}
|
|
68
|
+
}
|
|
@@ -1,13 +1,10 @@
|
|
|
1
1
|
import { IReviewRating } from "../common/i-review-rating.js";
|
|
2
|
-
import { IRankingDiscipline } from "./i-ranking-discipline.js";
|
|
3
2
|
export interface IOrganisationCard {
|
|
4
3
|
getNumberOfProgrammesForBachelors(): number;
|
|
5
4
|
getNumberOfProgrammesForDistanceLearning(): number;
|
|
6
5
|
getNumberOfProgrammesForMasters(): number;
|
|
7
6
|
getNumberOfProgrammesForPhd(): number;
|
|
8
7
|
getNumberOfProgrammesForShortCourses(): number;
|
|
9
|
-
getOrganisationGlobalMetaRankingPosition(): number | null;
|
|
10
|
-
getOrganisationMetaRankingPositionsByDiscipline(): IRankingDiscipline[] | null;
|
|
11
8
|
getOrganisationGlobalPositionPercentage(): string | null;
|
|
12
9
|
getOrganisationHasDeliveryMethodBlended(): boolean;
|
|
13
10
|
getOrganisationHasDeliveryMethodOnCampus(): boolean;
|
|
@@ -167,4 +167,16 @@ export interface IOrganisationSearchDocument {
|
|
|
167
167
|
* @return number
|
|
168
168
|
*/
|
|
169
169
|
getCityIdOfMainLocation(): number;
|
|
170
|
+
/**
|
|
171
|
+
* Gets the global ranking point of the organisation
|
|
172
|
+
*
|
|
173
|
+
* @return number | null
|
|
174
|
+
*/
|
|
175
|
+
getGlobalRankingPoint(): number | null;
|
|
176
|
+
/**
|
|
177
|
+
* Gets the ranked positions of the organisation by discipline
|
|
178
|
+
*
|
|
179
|
+
* @return Record<string, number> | null
|
|
180
|
+
*/
|
|
181
|
+
rankedPositionsByDiscipline(): Record<string, number> | null;
|
|
170
182
|
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|