@studyportals/domain-client 5.0.0 → 5.1.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/index.d.ts +3 -1
- package/index.js +3 -1
- package/index.js.map +1 -1
- package/package.json +53 -53
- package/src/models/organisation-search-document/i-organisation-search-document.d.ts +3 -3
- package/src/models/scholarship-search-document/i-scholarship-search-document.d.ts +38 -0
- package/src/models/scholarship-search-document/i-scholarship-search-document.js +3 -0
- package/src/models/scholarship-search-document/i-scholarship-search-document.js.map +1 -0
- package/src/models/scholarship-search-document/scholarship-search-document-client.d.ts +7 -0
- package/src/models/scholarship-search-document/scholarship-search-document-client.js +17 -0
- package/src/models/scholarship-search-document/scholarship-search-document-client.js.map +1 -0
package/index.d.ts
CHANGED
|
@@ -64,6 +64,8 @@ import { ISitemapCityInfo } from "./src/models/sitemap-cities-info/i-sitemap-cit
|
|
|
64
64
|
import { SitemapCitiesInfoClient } from "./src/models/sitemap-cities-info/sitemap-cities-info-client";
|
|
65
65
|
import { IScholarshipCard } from "./src/models/scholarship-card/i-scholarship-card";
|
|
66
66
|
import { PublicScholarshipCardClient } from "./src/models/scholarship-card/public-scholarship-card-client";
|
|
67
|
+
import { IScholarshipSearchDocument } from "./src/models/scholarship-search-document/i-scholarship-search-document";
|
|
68
|
+
import { ScholarshipSearchDocumentClient } from "./src/models/scholarship-search-document/scholarship-search-document-client";
|
|
67
69
|
import { IRanking } from './src/models/ranking-cards/i-ranking';
|
|
68
70
|
import { PortalType } from "./src/types/portal-type";
|
|
69
71
|
import { PortalMap } from "./src/types/portal-map";
|
|
@@ -77,4 +79,4 @@ import { CopilotProgrammeClient } from "./src/models/copilot-programme/copilot-p
|
|
|
77
79
|
import { ICopilotCountry } from "./src/models/copilot-country/i-copilot-country";
|
|
78
80
|
import { CopilotCountryClient } from "./src/models/copilot-country/copilot-country-client";
|
|
79
81
|
import { ICopilotRankingCard } from "./src/models/copilot-country/i-copilot-ranking-card";
|
|
80
|
-
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, 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, IScholarshipCard, PublicScholarshipCardClient, IRanking, ICompareProgramme, CompareProgrammeClient, PortalType, PortalMap, ModelClient, IOrganisationForSearch, PublicOrganisationForSearchClient, IOrganisationCard, IRankingDiscipline, OrganisationCardClient, ICopilotProgramme, ICopilotCountry, CopilotProgrammeClient, CopilotCountryClient, ICopilotRankingCard };
|
|
82
|
+
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, 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, IScholarshipCard, PublicScholarshipCardClient, IScholarshipSearchDocument, ScholarshipSearchDocumentClient, IRanking, ICompareProgramme, CompareProgrammeClient, PortalType, PortalMap, ModelClient, IOrganisationForSearch, PublicOrganisationForSearchClient, IOrganisationCard, IRankingDiscipline, OrganisationCardClient, ICopilotProgramme, ICopilotCountry, CopilotProgrammeClient, CopilotCountryClient, ICopilotRankingCard };
|
package/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.CopilotCountryClient = exports.CopilotProgrammeClient = exports.OrganisationCardClient = exports.PublicOrganisationForSearchClient = exports.ModelClient = exports.PortalType = exports.CompareProgrammeClient = exports.PublicScholarshipCardClient = exports.SitemapCitiesInfoClient = exports.SitemapArticlesInfoClient = exports.SitemapRankingsInfoClient = exports.OrganisationSearchDocumentClient = exports.SitemapOrganisationsInfoClient = exports.CustomerIOOrganisationClient = exports.SitemapDisciplinesInfoClient = exports.PublicSearchDisciplineClient = exports.SitemapCountryDegreeInfoClient = exports.SitemapCountriesInfoClient = exports.SitemapProgrammeInfoClient = exports.CustomerIOProgrammeClient = exports.BestfitProgrammeClient = exports.SearchProjectionClient = exports.ProgrammeCardClient = exports.PropertyNotAvailableException = exports.NotFoundException = exports.InternalServerException = exports.ClientException = exports.BadRequestException = void 0;
|
|
3
|
+
exports.CopilotCountryClient = exports.CopilotProgrammeClient = exports.OrganisationCardClient = exports.PublicOrganisationForSearchClient = exports.ModelClient = exports.PortalType = exports.CompareProgrammeClient = exports.ScholarshipSearchDocumentClient = exports.PublicScholarshipCardClient = exports.SitemapCitiesInfoClient = exports.SitemapArticlesInfoClient = exports.SitemapRankingsInfoClient = exports.OrganisationSearchDocumentClient = exports.SitemapOrganisationsInfoClient = exports.CustomerIOOrganisationClient = exports.SitemapDisciplinesInfoClient = exports.PublicSearchDisciplineClient = exports.SitemapCountryDegreeInfoClient = exports.SitemapCountriesInfoClient = exports.SitemapProgrammeInfoClient = exports.CustomerIOProgrammeClient = exports.BestfitProgrammeClient = exports.SearchProjectionClient = exports.ProgrammeCardClient = exports.PropertyNotAvailableException = exports.NotFoundException = exports.InternalServerException = exports.ClientException = exports.BadRequestException = void 0;
|
|
4
4
|
const bad_request_exception_1 = require("./src/exceptions/bad-request-exception");
|
|
5
5
|
Object.defineProperty(exports, "BadRequestException", { enumerable: true, get: function () { return bad_request_exception_1.BadRequestException; } });
|
|
6
6
|
const client_exception_1 = require("./src/exceptions/client-exception");
|
|
@@ -45,6 +45,8 @@ const sitemap_cities_info_client_1 = require("./src/models/sitemap-cities-info/s
|
|
|
45
45
|
Object.defineProperty(exports, "SitemapCitiesInfoClient", { enumerable: true, get: function () { return sitemap_cities_info_client_1.SitemapCitiesInfoClient; } });
|
|
46
46
|
const public_scholarship_card_client_1 = require("./src/models/scholarship-card/public-scholarship-card-client");
|
|
47
47
|
Object.defineProperty(exports, "PublicScholarshipCardClient", { enumerable: true, get: function () { return public_scholarship_card_client_1.PublicScholarshipCardClient; } });
|
|
48
|
+
const scholarship_search_document_client_1 = require("./src/models/scholarship-search-document/scholarship-search-document-client");
|
|
49
|
+
Object.defineProperty(exports, "ScholarshipSearchDocumentClient", { enumerable: true, get: function () { return scholarship_search_document_client_1.ScholarshipSearchDocumentClient; } });
|
|
48
50
|
const portal_type_1 = require("./src/types/portal-type");
|
|
49
51
|
Object.defineProperty(exports, "PortalType", { enumerable: true, get: function () { return portal_type_1.PortalType; } });
|
|
50
52
|
const model_client_1 = require("./src/model-client");
|
package/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,kFAA6E;AAmF5E,oGAnFQ,2CAAmB,OAmFR;AAlFpB,wEAAoE;AAmFnE,gGAnFQ,kCAAe,OAmFR;AAlFhB,0FAAqF;AAmFpF,wGAnFQ,mDAAuB,OAmFR;AAlFxB,8EAAyE;AAmFxE,kGAnFQ,uCAAiB,OAmFR;AAlFlB,wGAAkG;AAmFjG,8GAnFQ,gEAA6B,OAmFR;AAtE9B,6FAAwF;AAmFvF,oGAnFQ,2CAAmB,OAmFR;AA5EpB,sGAAiG;AAmFhG,uGAnFQ,iDAAsB,OAmFR;AA/EvB,sGAAiG;AAmFhG,uGAnFQ,iDAAsB,OAmFR;AA7EvB,+GAA0G;AAmFzG,0GAnFQ,uDAAyB,OAmFR;AAjF1B,qHAA+G;AAmF9G,2GAnFQ,0DAA0B,OAmFR;AAjF3B,qHAA+G;AAmF9G,2GAnFQ,0DAA0B,OAmFR;AAhF3B,oIAA6H;AAmF5H,+GAnFQ,mEAA8B,OAmFR;AAjF/B,oHAA8G;AAmF7G,6GAnFQ,8DAA4B,OAmFR;AAjF7B,2HAAqH;AAmFpH,6GAnFQ,8DAA4B,OAmFR;AA9E7B,wHAAmH;AAmFlH,6GAnFQ,6DAA4B,OAmFR;AAjF7B,iIAA2H;AAmF1H,+GAnFQ,kEAA8B,OAmFR;AAhF/B,sGAAiG;AAuGhG,uGAvGQ,iDAAsB,OAuGR;AArGvB,uIAAiI;AAgFhI,iHAhFQ,sEAAgC,OAgFR;AA9EjC,kHAA4G;AAgF3G,0GAhFQ,wDAAyB,OAgFR;AA9E1B,kHAA4G;AAgF3G,0GAhFQ,wDAAyB,OAgFR;AA9E1B,4GAAsG;AAgFrG,wGAhFQ,oDAAuB,OAgFR;AA9ExB,iHAA2G;AAgF1G,4GAhFQ,4DAA2B,OAgFR;AA9E5B,oIAA8H;AAgF7H,gHAhFQ,oEAA+B,OAgFR;AA9EhC,yDAAqD;AAkFpD,2FAlFQ,wBAAU,OAkFR;AAhFX,qDAAiD;AAkFhD,4FAlFQ,0BAAW,OAkFR;AAhFZ,sGAAiG;AA6EhG,uGA7EQ,iDAAsB,OA6ER;AA3EvB,sIAA+H;AAgF9H,kHAhFQ,yEAAiC,OAgFR;AA9ElC,sGAAiG;AAoFhG,uGApFQ,iDAAsB,OAoFR;AAlFvB,gGAA2F;AAmF1F,qGAnFQ,6CAAoB,OAmFR"}
|
package/package.json
CHANGED
|
@@ -1,55 +1,55 @@
|
|
|
1
1
|
{
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
2
|
+
"name": "@studyportals/domain-client",
|
|
3
|
+
"version": "5.1.0",
|
|
4
|
+
"description": "Responsible for fetching data from the Domain API",
|
|
5
|
+
"main": "index.js",
|
|
6
|
+
"author": "StudyPortals B.V.",
|
|
7
|
+
"contributors": [
|
|
8
|
+
"braaibander <danny@studyportals.com>"
|
|
9
|
+
],
|
|
10
|
+
"license": "BSD-3-Clause",
|
|
11
|
+
"scripts": {
|
|
12
|
+
"test": "mocha --reporter spec \"tests/**/*.test.ts\"",
|
|
13
|
+
"coverage": "nyc mocha --reporter dot \"tests/**/*.test.ts\"",
|
|
14
|
+
"lint": "eslint . --ext .ts --max-warnings=0",
|
|
15
|
+
"lint:fix": "eslint . --ext .ts --fix",
|
|
16
|
+
"pre-push": "npm run test && npm run coverage && npm run lint",
|
|
17
|
+
"prepare-dist": "npm run test && rm -fR bin && npx tsc && cp package.json bin/package.json && rm -fR bin/tests",
|
|
18
|
+
"publish-beta": "npm run prepare-dist && npm publish ./bin --tag beta",
|
|
19
|
+
"publish-major": "npm version major && npm run prepare-dist && npm publish ./bin",
|
|
20
|
+
"publish-minor": "npm version minor && npm run prepare-dist && npm publish ./bin",
|
|
21
|
+
"publish-patch": "npm version patch && npm run prepare-dist && npm publish ./bin",
|
|
22
|
+
"publish-current": "npm run prepare-dist && npm publish ./bin"
|
|
23
|
+
},
|
|
24
|
+
"husky": {
|
|
25
|
+
"hooks": {
|
|
26
|
+
"pre-push": "npm run pre-push"
|
|
27
|
+
}
|
|
28
|
+
},
|
|
29
|
+
"dependencies": {
|
|
30
|
+
"axios": "^1.6.0"
|
|
31
|
+
},
|
|
32
|
+
"devDependencies": {
|
|
33
|
+
"@studyportals/code-style": "^2.0.4",
|
|
34
|
+
"@testdeck/mocha": "^0.3.3",
|
|
35
|
+
"@types/axios": "^0.14.0",
|
|
36
|
+
"@types/mocha": "^10.0.0",
|
|
37
|
+
"@types/moxios": "^0.4.9",
|
|
38
|
+
"@types/node": "^14.14.8",
|
|
39
|
+
"@types/reflect-metadata": "^0.1.0",
|
|
40
|
+
"@typescript-eslint/eslint-plugin": "^4.8.1",
|
|
41
|
+
"@typescript-eslint/parser": "^4.8.1",
|
|
42
|
+
"eslint": "^7.13.0",
|
|
43
|
+
"eslint-plugin-import": "^2.22.1",
|
|
44
|
+
"eslint-plugin-mocha": "^10.1.0",
|
|
45
|
+
"husky": "^4.3.0",
|
|
46
|
+
"mocha": "^10.1.0",
|
|
47
|
+
"moxios": "^0.4.0",
|
|
48
|
+
"nyc": "^15.1.0",
|
|
49
|
+
"source-map-support": "^0.5.19",
|
|
50
|
+
"ts-node": "^10.9.1",
|
|
51
|
+
"tslint": "^6.1.3",
|
|
52
|
+
"typemoq": "^2.1.0",
|
|
53
|
+
"typescript": "^4.9.3"
|
|
54
|
+
}
|
|
55
55
|
}
|
|
@@ -48,19 +48,19 @@ export interface IOrganisationSearchDocument {
|
|
|
48
48
|
*/
|
|
49
49
|
getPremiumType(): string | null;
|
|
50
50
|
/**
|
|
51
|
-
*
|
|
51
|
+
* Checks whether the organisation has studies taught both online and on campus
|
|
52
52
|
*
|
|
53
53
|
* @return boolean
|
|
54
54
|
*/
|
|
55
55
|
hasDeliveryMethodBlended(): boolean;
|
|
56
56
|
/**
|
|
57
|
-
*
|
|
57
|
+
* Checks whether the organisation has studies taught on campus
|
|
58
58
|
*
|
|
59
59
|
* @return boolean
|
|
60
60
|
*/
|
|
61
61
|
hasDeliveryMethodOnCampus(): boolean;
|
|
62
62
|
/**
|
|
63
|
-
*
|
|
63
|
+
* Checks whether the organisation has studies taught online
|
|
64
64
|
*
|
|
65
65
|
* @return boolean
|
|
66
66
|
*/
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
export interface IScholarshipSearchDocument {
|
|
2
|
+
/**
|
|
3
|
+
* @return number[]
|
|
4
|
+
*/
|
|
5
|
+
getDegrees(): number[];
|
|
6
|
+
/**
|
|
7
|
+
* @return string[]
|
|
8
|
+
*/
|
|
9
|
+
getDestinationCountryIsoCodes(): string[];
|
|
10
|
+
/**
|
|
11
|
+
* @return number[]
|
|
12
|
+
*/
|
|
13
|
+
getDestinationRegionIds(): number[];
|
|
14
|
+
/**
|
|
15
|
+
* @return number[]
|
|
16
|
+
*/
|
|
17
|
+
getDisciplineIds(): number[];
|
|
18
|
+
/**
|
|
19
|
+
* @return number[]
|
|
20
|
+
*/
|
|
21
|
+
getFormats(): number[];
|
|
22
|
+
getId(): number;
|
|
23
|
+
/**
|
|
24
|
+
* @return string[]
|
|
25
|
+
*/
|
|
26
|
+
getOriginCountryIsoCodes(): string[];
|
|
27
|
+
getPresence(): number;
|
|
28
|
+
getTitle(): string;
|
|
29
|
+
/**
|
|
30
|
+
* @return number[]
|
|
31
|
+
*/
|
|
32
|
+
getTypes(): number[];
|
|
33
|
+
getUniversityProviderId(): number | null;
|
|
34
|
+
isEligibleForAllDestinationCountries(): boolean;
|
|
35
|
+
isEligibleForAllDestinationRegions(): boolean;
|
|
36
|
+
isEligibleForAllDisciplines(): boolean;
|
|
37
|
+
isEligibleForAllOriginCountries(): boolean;
|
|
38
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"i-scholarship-search-document.js","sourceRoot":"","sources":["../../../../src/models/scholarship-search-document/i-scholarship-search-document.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { IScholarshipSearchDocument } from "../../..";
|
|
2
|
+
import { ModelClient } from "../../model-client";
|
|
3
|
+
export declare class ScholarshipSearchDocumentClient extends ModelClient<IScholarshipSearchDocument> {
|
|
4
|
+
protected getModelName(): string;
|
|
5
|
+
protected getVersion(): string;
|
|
6
|
+
isPublic(): boolean;
|
|
7
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ScholarshipSearchDocumentClient = void 0;
|
|
4
|
+
const model_client_1 = require("../../model-client");
|
|
5
|
+
class ScholarshipSearchDocumentClient extends model_client_1.ModelClient {
|
|
6
|
+
getModelName() {
|
|
7
|
+
return 'scholarship-search-document';
|
|
8
|
+
}
|
|
9
|
+
getVersion() {
|
|
10
|
+
return 'v1';
|
|
11
|
+
}
|
|
12
|
+
isPublic() {
|
|
13
|
+
return false;
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
|
+
exports.ScholarshipSearchDocumentClient = ScholarshipSearchDocumentClient;
|
|
17
|
+
//# sourceMappingURL=scholarship-search-document-client.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"scholarship-search-document-client.js","sourceRoot":"","sources":["../../../../src/models/scholarship-search-document/scholarship-search-document-client.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AAEjD,MAAa,+BAAgC,SAAQ,0BAAuC;IACjF,YAAY;QACrB,OAAO,6BAA6B,CAAC;IACtC,CAAC;IAES,UAAU;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,OAAO,KAAK,CAAC;IACd,CAAC;CACD;AAZD,0EAYC"}
|