@studyportals/domain-client 3.18.0 → 3.20.0

package/src/models/search-projection/i-search-projection.ts

@@ -1,216 +0,0 @@
-import { IGeoTargetingValues, IOrganisationValues, IPremiumValues, ITuitionValues } from "../../..";
-
-export interface ISearchProjection {
-
-	/**
-	 * List of area IDs where the programme is taught at (through venues).
-	 *
-	 * @return number[]
-	 */
-	getAreas(): number[];
-
-	/**
-	 * Current boost value for the programme (campaign automation).
-	 *
-	 * @return number
-	 */
-	getBoost(): number;
-
-	/**
-	 * Contents text of the programme (stripped of html tags).
-	 *
-	 * @return string
-	 */
-	getContents(): string;
-
-	/**
-	 * List of country IDs where the programme is taught at (through venues).
-	 *
-	 * @return number[]
-	 */
-	getCountries(): number[];
-
-	/**
-	 * Unformatted degree of the programme.
-	 *
-	 * @return string
-	 */
-	getDegree(): string;
-
-	/**
-	 * Formatted degree of the programme.
-	 *
-	 * @return string
-	 */
-	getDegreeFormatted(): string;
-
-	/**
-	 * List of intensity densities of the programme.
-	 *
-	 * @return string[]
-	 */
-	getDensity(): string[];
-
-	/**
-	 * Description text of the programme (stripped of html tags).
-	 *
-	 * @return string
-	 */
-	getDescription(): string;
-
-	/**
-	 * List of disciplines connected to the programme (includes parent IDs).
-	 *
-	 * @return number[]
-	 */
-	getDisciplines(): number[];
-
-	/**
-	 * List of educational forms.
-	 *
-	 * @return string[]
-	 */
-	getEducationalForms(): string[];
-
-	/**
-	 * Full time duration in days.
-	 *
-	 * @return number
-	 */
-	getFullTimeDuration(): number;
-
-	canShowFullTimeDuration(): boolean;
-
-	getGeoTargetingValues(): IGeoTargetingValues;
-
-	/**
-	 * Id of the programme.
-	 *
-	 * @return number
-	 */
-	getId(): number;
-
-	/**
-	 * List of language IDs the programme is taught in.
-	 *
-	 * @return number[]
-	 */
-	getLanguages(): number[];
-
-	/**
-	 * Study level of the programme.
-	 *
-	 * @return string
-	 */
-	getLevel(): string;
-
-	/**
-	 * Url of the logo to display (square if available, legacy otherwise).
-	 *
-	 * @return string
-	 */
-	getLogo(): string;
-
-	canShowLogo(): boolean;
-
-	/**
-	 * Url of the legacy logo to display.
-	 *
-	 * @return string
-	 */
-	getLogoOld(): string;
-
-	canShowLogoOld(): boolean;
-
-	/**
-	 * List of study methods.
-	 *
-	 * @return string[]
-	 */
-	getMethods(): string[];
-
-	getOrganisationValues(): IOrganisationValues;
-
-	/**
-	 * Part time duration in days.
-	 *
-	 * @return number
-	 */
-	getPartTimeDuration(): number;
-
-	canShowPartTimeDuration(): boolean;
-
-	getPremiumValues(): IPremiumValues;
-
-	/**
-	 * The programme's probability seed value (previously known as 'entropy').
-	 *
-	 * Should be a value between 0 and 4095.
-	 *
-	 * @return number
-	 */
-	getProbabilitySeed(): number;
-
-	/**
-	 * List of region IDs where the programme is taught at (through venues).
-	 *
-	 * Includes both the direct regions as the parent regions.
-	 *
-	 * @return number[]
-	 */
-	getRegions(): number[];
-
-	/**
-	 * List of special programme types (executive, joint, erasmus).
-	 *
-	 * @return string[]
-	 */
-	getSpecialStudy(): string[];
-
-	/**
-	 * List of the start months for the programme.
-	 *
-	 * @return number[]
-	 */
-	getStartDates(): number[];
-
-	/**
-	 * Summary text of the programme (stripped of html tags).
-	 *
-	 * @return string
-	 */
-	getSummary(): string;
-
-	/**
-	 * Title of the programme.
-	 *
-	 * @return string
-	 */
-	getTitle(): string;
-
-	getTuitionValues(): ITuitionValues;
-
-	canShowTuitionValues(): boolean;
-
-	/**
-	 * List of json encoded venue descriptions.
-	 *
-	 * Example of structure:
-	 * {
-	 *'city': 'Eindhoven',
-	 *'country': 'Netherlands',
-	 *'area': 'North Brabant',
-	 *'display_area': true
-	 * }
-	 *
-	 * @return string[]
-	 */
-	getVenues(): string[];
-
-	/**
-	 * Public status of the programme.
-	 *
-	 * @return boolean
-	 */
-	isPublic(): boolean;
-}

package/src/models/search-projection/i-tuition-values.ts

@@ -1,63 +0,0 @@
-export interface ITuitionValues {
-
-	/**
-	 * Tuition (converted to per year if possible) for EEA students.
-	 *
-	 * @return number
-	 */
-	getTuitionEea(): number;
-
-	canShowTuitionEea(): boolean;
-
-	/**
-	 * Tuition currency.
-	 *
-	 * @return number
-	 */
-	getTuitionEeaCurrency(): number;
-
-	canShowTuitionEeaCurrency(): boolean;
-
-	/**
-	 * Tuition (converted to per year if possible) for international students.
-	 *
-	 * @return number
-	 */
-	getTuitionInternational(): number;
-
-	canShowTuitionInternational(): boolean;
-
-	/**
-	 * Tuition currency.
-	 *
-	 * @return number
-	 */
-	getTuitionInternationalCurrency(): number;
-
-	canShowTuitionInternationalCurrency(): boolean;
-
-	/**
-	 * Tuition (converted to per year if possible) for national students.
-	 *
-	 * @return number
-	 */
-	getTuitionNational(): number;
-
-	canShowTuitionNational(): boolean;
-
-	/**
-	 * Tuition currency.
-	 *
-	 * @return number
-	 */
-	getTuitionNationalCurrency(): number;
-
-	canShowTuitionNationalCurrency(): boolean;
-
-	/**
-	 * Unit all tuition fees are provided in.
-	 *
-	 * @return number
-	 */
-	getTuitionUnitType(): number;
-}

package/src/models/search-projection/search-projection-client.ts

@@ -1,16 +0,0 @@
-import { ISearchProjection } from "../../..";
-import { ModelClient } from "../../model-client";
-
-export class SearchProjectionClient extends ModelClient<ISearchProjection> {
-	protected getModelName(): string {
-		return 'search-projection';
-	}
-
-	protected getVersion(): string {
-		return 'v1';
-	}
-
-	public isPublic(): boolean {
-		return false;
-	}
-}

package/src/models/sitemap-articles-info/i-sitemap-article-info.ts

@@ -1,17 +0,0 @@
-export interface ISitemapArticleInfo {
-
-	/**
-	 * @return number
-	 */
-	getId(): number;
-
-	/**
-	 * @return string
-	 */
-	getPath(): string;
-
-	/**
-	 * @return boolean
-	 */
-	shouldBeInSitemap(): boolean;
-}

package/src/models/sitemap-articles-info/sitemap-articles-info-client.ts

@@ -1,16 +0,0 @@
-import { ISitemapArticleInfo } from "../../..";
-import { ModelClient } from "../../model-client";
-
-export class SitemapArticlesInfoClient extends ModelClient<ISitemapArticleInfo> {
-	protected getModelName(): string {
-		return 'sitemap-articles-info';
-	}
-
-	protected getVersion(): string {
-		return 'v1';
-	}
-
-	public isPublic(): boolean {
-		return false;
-	}
-}

package/src/models/sitemap-cities-info/i-sitemap-city-info.ts

@@ -1,17 +0,0 @@
-export interface ISitemapCityInfo {
-
-	/**
-	 * @return number
-	 */
-	getId(): number;
-
-	/**
-	 * @return string
-	 */
-	getPath(): string;
-
-	/**
-	 * @return boolean
-	 */
-	shouldBeInSitemap(): boolean;
-}

package/src/models/sitemap-cities-info/sitemap-cities-info-client.ts

@@ -1,16 +0,0 @@
-import { ISitemapCityInfo } from "../../..";
-import { ModelClient } from "../../model-client";
-
-export class SitemapCitiesInfoClient extends ModelClient<ISitemapCityInfo> {
-	protected getModelName(): string {
-		return 'sitemap-cities-info';
-	}
-
-	protected getVersion(): string {
-		return 'v1';
-	}
-
-	public isPublic(): boolean {
-		return false;
-	}
-}

package/src/models/sitemap-countries-info/i-sitemap-country-info.ts

@@ -1,17 +0,0 @@
-export interface ISitemapCountryInfo {
-
-	/**
-	 * @return number
-	 */
-	getId(): number;
-
-	/**
-	 * @return string
-	 */
-	getPath(): string;
-
-	/**
-	 * @return boolean
-	 */
-	shouldBeInSitemap(): boolean;
-}

package/src/models/sitemap-countries-info/sitemap-countries-info-client.ts

@@ -1,16 +0,0 @@
-import { ISitemapCountryInfo } from "../../..";
-import { ModelClient } from "../../model-client";
-
-export class SitemapCountriesInfoClient extends ModelClient<ISitemapCountryInfo> {
-	protected getModelName(): string {
-		return 'sitemap-countries-info';
-	}
-
-	protected getVersion(): string {
-		return 'v1';
-	}
-
-	public isPublic(): boolean {
-		return false;
-	}
-}

package/src/models/sitemap-country-degree-info/i-degree-info.ts

@@ -1,17 +0,0 @@
-export interface IDegreeInfo {
-
-	/**
-	 * @return number
-	 */
-	getId(): number;
-
-	/**
-	 * @return string
-	 */
-	getLevel(): string;
-
-	/**
-	 * @return string
-	 */
-	getPath(): string;
-}

package/src/models/sitemap-country-degree-info/i-sitemap-country-degree-info.ts

@@ -1,14 +0,0 @@
-import { IDegreeInfo } from "../../..";
-
-export interface ISitemapCountryDegreeInfo {
-
-	/**
-	 * @return IDegreeInfo[]
-	 */
-	getDegrees(): IDegreeInfo[];
-
-	/**
-	 * @return boolean
-	 */
-	shouldBeInSitemap(): boolean;
-}

package/src/models/sitemap-country-degree-info/sitemap-country-degree-info-client.ts

@@ -1,16 +0,0 @@
-import { ISitemapCountryDegreeInfo } from "../../..";
-import { ModelClient } from "../../model-client";
-
-export class SitemapCountryDegreeInfoClient extends ModelClient<ISitemapCountryDegreeInfo> {
-	protected getModelName(): string {
-		return 'sitemap-country-degree-info';
-	}
-
-	protected getVersion(): string {
-		return 'v1';
-	}
-
-	public isPublic(): boolean {
-		return false;
-	}
-}

package/src/models/sitemap-disciplines-info/i-sitemap-discipline-info.ts

@@ -1,17 +0,0 @@
-export interface ISitemapDisciplineInfo {
-
-	/**
-	 * @return number
-	 */
-	getId(): number;
-
-	/**
-	 * @return string
-	 */
-	getPath(): string;
-
-	/**
-	 * @return boolean
-	 */
-	shouldBeInSitemap(): boolean;
-}

package/src/models/sitemap-disciplines-info/sitemap-disciplines-info-client.ts

@@ -1,16 +0,0 @@
-import { ISitemapDisciplineInfo } from "../../..";
-import { ModelClient } from "../../model-client";
-
-export class SitemapDisciplinesInfoClient extends ModelClient<ISitemapDisciplineInfo> {
-	protected getModelName(): string {
-		return 'sitemap-disciplines-info';
-	}
-
-	protected getVersion(): string {
-		return 'v1';
-	}
-
-	public isPublic(): boolean {
-		return false;
-	}
-}

package/src/models/sitemap-organisations-info/i-sitemap-organisation-info.ts

@@ -1,32 +0,0 @@
-export interface ISitemapOrganisationInfo {
-
-	/**
-	 * @return number
-	 */
-	getId(): number;
-
-	/**
-	 * @return string
-	 */
-	getPath(): string;
-
-	/**
-	 * @return boolean
-	 */
-	shouldBeInSitemapForBachelors(): boolean;
-
-	/**
-	 * @return boolean
-	 */
-	shouldBeInSitemapForMasters(): boolean;
-
-	/**
-	 * @return boolean
-	 */
-	shouldBeInSitemapForPhd(): boolean;
-
-	/**
-	 * @return boolean
-	 */
-	shouldBeInSitemapForShortCourses(): boolean;
-}

package/src/models/sitemap-organisations-info/sitemap-organisations-info-client.ts

@@ -1,16 +0,0 @@
-import { ISitemapOrganisationInfo } from "../../..";
-import { ModelClient } from "../../model-client";
-
-export class SitemapOrganisationsInfoClient extends ModelClient<ISitemapOrganisationInfo> {
-	protected getModelName(): string {
-		return 'sitemap-organisations-info';
-	}
-
-	protected getVersion(): string {
-		return 'v1';
-	}
-
-	public isPublic(): boolean {
-		return false;
-	}
-}

package/src/models/sitemap-programme-info/i-sitemap-programme-info.ts

@@ -1,32 +0,0 @@
-export interface ISitemapProgrammeInfo {
-
-	/**
-	 * @return number
-	 */
-	getId(): number;
-
-	/**
-	 * @return string
-	 */
-	getPath(): string;
-
-	/**
-	 * @return boolean
-	 */
-	shouldBeInSitemapForBachelors(): boolean;
-
-	/**
-	 * @return boolean
-	 */
-	shouldBeInSitemapForMasters(): boolean;
-
-	/**
-	 * @return boolean
-	 */
-	shouldBeInSitemapForPhd(): boolean;
-
-	/**
-	 * @return boolean
-	 */
-	shouldBeInSitemapForShortCourses(): boolean;
-}

package/src/models/sitemap-programme-info/sitemap-programme-info-client.ts

@@ -1,16 +0,0 @@
-import { ISitemapProgrammeInfo } from "../../..";
-import { ModelClient } from "../../model-client";
-
-export class SitemapProgrammeInfoClient extends ModelClient<ISitemapProgrammeInfo> {
-	protected getModelName(): string {
-		return 'sitemap-programme-info';
-	}
-
-	protected getVersion(): string {
-		return 'v1';
-	}
-
-	public isPublic(): boolean {
-		return false;
-	}
-}

package/src/models/sitemap-rankings-info/i-sitemap-rankings-info.ts

@@ -1,17 +0,0 @@
-export interface ISitemapRankingsInfo {
-
-	/**
-	 * @return number
-	 */
-	getId(): number;
-
-	/**
-	 * @return string
-	 */
-	getPath(): string;
-
-	/**
-	 * @return boolean
-	 */
-	shouldBeInSitemap(): boolean;
-}

package/src/models/sitemap-rankings-info/sitemap-rankings-info-client.ts

@@ -1,16 +0,0 @@
-import { ISitemapRankingsInfo } from "../../..";
-import { ModelClient } from "../../model-client";
-
-export class SitemapRankingsInfoClient extends ModelClient<ISitemapRankingsInfo> {
-	protected getModelName(): string {
-		return 'sitemap-rankings-info';
-	}
-
-	protected getVersion(): string {
-		return 'v1';
-	}
-
-	public isPublic(): boolean {
-		return false;
-	}
-}

package/src/types/portal-map.ts

@@ -1,3 +0,0 @@
-import { PortalType } from "./portal-type";
-
-export type PortalMap = Map<PortalType, string>

package/src/types/portal-type.ts

@@ -1,7 +0,0 @@
-export enum PortalType {
-	MASTER= 'master',
-	BACHELOR = 'bachelor',
-	PHD = 'phd',
-	SHORT = 'short',
-	DISTANCE_LEARNING = 'distance_learning',
-}

package/src/types.ts

@@ -1,4 +0,0 @@
-export type Model = Record<string, Callable>;
-export type Callable = () => CallableReturnType|CallableReturnType[];
-export type CallableReturnType = AcceptedType | Model;
-export type AcceptedType = string | string[] | number | number[] | boolean | null | Date;

package/tsconfig.json

@@ -1,40 +0,0 @@
-{
-	"compilerOptions": {
-		"outDir": "bin",
-		"rootDir": "",
-		"moduleResolution": "node",
-		"declaration": true,
-		"alwaysStrict": true,
-		"strictNullChecks": true,
-		"allowJs": false,
-		"allowUnreachableCode": false,
-		"allowUnusedLabels": false,
-		"noUnusedLocals": false,
-		"noUnusedParameters": false,
-
-		"noFallthroughCasesInSwitch": true,
-		"noImplicitAny": true,
-		"noImplicitReturns": true,
-		"noImplicitThis": true,
-
-		"sourceMap": true,
-
-		"target": "es2017",
-		"lib": ["es2017"],
-		"module": "commonjs",
-		"experimentalDecorators": true,
-		"emitDecoratorMetadata": true,
-		"types": [
-			"reflect-metadata",
-			"node"
-		],
-		"skipLibCheck": true
-	},
-	"typeRoots": [
-		"node_modules/@types/"
-	],
-	"exclude": [
-		"node_modules",
-		"bin"
-	]
-}