@studyportals/domain-client 3.18.0 → 3.19.1-beta.0

package/src/model-client.ts

@@ -1,77 +0,0 @@
-import { DomainClient } from "./domain-client";
-import { ClientException } from "./exceptions/client-exception";
-import { IModelDescription } from "./i-model-description";
-import { ModelFactory } from "./model-factory";
-import { PortalMap } from "./types/portal-map";
-
-
-export abstract class ModelClient<T> {
-	private readonly domainClient: DomainClient | null;
-	private readonly modelFactory: ModelFactory<T>;
-
-	constructor(
-		baseUrl?: string,
-		apiKey?: string,
-		seed?: number,
-		portalMap?: PortalMap
-	) {
-		if (!baseUrl || !seed) {
-			return;
-		}
-
-		this.modelFactory = new ModelFactory<T>(portalMap);
-		this.domainClient = new DomainClient(
-			baseUrl,
-			apiKey,
-			this.getModelName(),
-			this.getVersion(),
-			this.isPublic(),
-			seed
-		);
-	}
-
-	public async fetch(id: number): Promise<T> {
-		const modelDescriptions = await this.fetchDescription(id);
-		return this.modelFactory.fromDescription(modelDescriptions);
-	}
-
-	public async fetchDescription(id: number): Promise<IModelDescription> {
-		if (!this.domainClient) {
-			throw new ClientException(
-				"Offline mode active: did you provide all parameters " +
-				"in the constructor?"
-			);
-		}
-		const result = await this.domainClient.doRequest([id]);
-		return result[0];
-	}
-
-	public async fetchMultiple(ids: number[]): Promise<T[]> {
-		const descriptions = await this.fetchMultipleDescriptions(ids);
-		return this.modelFactory.fromDescriptions(descriptions);
-	}
-
-	public async fetchMultipleDescriptions(ids: number[]): Promise<IModelDescription[]> {
-		if (!this.domainClient) {
-			throw new ClientException(
-				'Offline mode active: did you provide all parameters ' +
-				'in the constructor?'
-			);
-		}
-		return await this.domainClient.doRequest(ids);
-	}
-
-	public fromDescription(description: IModelDescription): T {
-		return this.modelFactory.fromDescription(description);
-	}
-
-	public fromDescriptions(descriptions: IModelDescription[]): T[] {
-		return this.modelFactory.fromDescriptions(descriptions);
-	}
-
-	protected abstract getModelName(): string;
-
-	protected abstract getVersion(): string;
-
-	public abstract isPublic(): boolean;
-}

package/src/model-factory.ts

@@ -1,94 +0,0 @@
-import { InternalLinkFactory } from "./factories/InternalLinkFactory";
-import { DateFactory } from "./factories/DateFactory";
-import { IClassFactory } from "./i-class-factory";
-import { IModelDescription, isModelDescription } from "./i-model-description";
-import { PropertyNotAvailableException } from "./exceptions/property-not-available-exception";
-import { Callable, CallableReturnType, Model } from "./types";
-import { PortalMap } from "./types/portal-map";
-import { PortalType } from "./types/portal-type";
-
-export class ModelFactory<T> {
-
-	private customClassFactories: Map<string, IClassFactory>;
-
-	constructor(portalMap: PortalMap = new Map<PortalType, string>()) {
-		const factories = new Map<string, IClassFactory>();
-		factories.set('IInternalLink', new InternalLinkFactory(portalMap));
-		factories.set('SerializableDateTime', new DateFactory());
-
-		this.customClassFactories = factories;
-	}
-
-	public fromDescription(data: IModelDescription): T {
-		return this.unpackClass(data) as unknown as T;
-	}
-
-	public fromDescriptions(data: IModelDescription[]): T[] {
-		const models: T[] = [];
-		for (const modelDescription of data) {
-			models.push(this.unpackClass(modelDescription) as unknown as T);
-		}
-		return models;
-	}
-
-	private unpackClass(data: IModelDescription): CallableReturnType {
-
-
-		const unpacked: Model = {};
-		for (const functionName in data.func) {
-			unpacked[functionName] = this.getCallable(functionName, data);
-		}
-
-		const factory = this.customClassFactories.get(data.class);
-		if (factory !== undefined) {
-			return factory.create(unpacked, data.parameters);
-		}
-
-		return unpacked;
-	}
-
-	private getCallable(
-		functionName: string,
-		data: IModelDescription
-	): Callable {
-		const propertyName = functionName.substr(3);
-		const canShowFunction = 'canShow' + propertyName;
-
-		const value: unknown = data.func[functionName];
-		let returnValue: CallableReturnType|CallableReturnType[];
-
-		if (isModelDescription(value)) {
-			returnValue = this.unpackClass(value);
-		} else if (Array.isArray(value)) {
-			returnValue = this.unpackArray(value);
-		} else {
-			returnValue = value as CallableReturnType;
-		}
-
-		if (canShowFunction in data.func) {
-			return (): any => {
-				if (data.func[canShowFunction] === false) {
-					throw new PropertyNotAvailableException(
-						`Property '${propertyName}' not available`
-					);
-				}
-				return returnValue;
-			};
-		}
-		return (): any => {
-			return returnValue;
-		};
-	}
-
-	private unpackArray(list: any[]): CallableReturnType[] {
-		return list.map(
-			item => {
-				if (isModelDescription(item)) {
-					return this.unpackClass(item)
-				}
-
-				return item as CallableReturnType;
-			}
-		);
-	}
-}

package/src/models/bestfit-programme/bestfit-programme-client.ts

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

package/src/models/bestfit-programme/i-best-fit-programme.ts

@@ -1,102 +0,0 @@
-import { ICity, IEnglishRequirements, IGPARequirement, ILivingCost, ITuitionFee } from "../../..";
-
-export interface IBestFitProgramme {
-
-	/**
-	 * Average university ranking across multiple ranking institutes.
-	 *
-	 * @return number
-	 */
-	getAverageRankingPosition(): number;
-
-	canShowAverageRankingPosition(): boolean;
-
-	/**
-	 * City which programme is given in
-	 *
-	 * @return ICity
-	 */
-	getCity(): ICity;
-
-	/**
-	 * Get country id the programme is teached in
-	 *
-	 * @return number
-	 */
-	getCountryId(): number;
-
-	/**
-	 * Discipline ids which the program is linked to.
-	 *
-	 * @return number[]
-	 */
-	getDisciplineIds(): number[];
-
-	canShowDisciplineIds(): boolean;
-
-	/**
-	 * English level requirements.
-	 *
-	 * @return IEnglishRequirements
-	 */
-	getEnglishRequirements(): IEnglishRequirements;
-
-	/**
-	 * GPA requirements
-	 *
-	 * @return IGPARequirement
-	 */
-	getGPA(): IGPARequirement;
-
-	canShowGPA(): boolean;
-
-	/**
-	 * Id of the programme.
-	 *
-	 * @return number
-	 */
-	getId(): number;
-
-	/**
-	 * Estimated living cost based on universities location.
-	 *
-	 * @return ILivingCost
-	 */
-	getLivingCost(): ILivingCost;
-
-	canShowLivingCost(): boolean;
-
-	/**
-	 * Minimum required education level
-	 *
-	 * @return string | null
-	 */
-	getRequiredEducationalLevel(): string | null;
-
-	canShowRequiredEducationalLevel(): boolean;
-
-	/**
-	 * The programmes tuition fees
-	 *
-	 * @return ITuitionFee[]
-	 */
-	getTuitionFees(): ITuitionFee[];
-
-	canShowTuitionFees(): boolean;
-
-	/**
-	 * Amount of years required as work experience
-	 *
-	 * @return number
-	 */
-	getWorkExperienceYears(): number;
-
-	canShowWorkExperienceYears(): boolean;
-
-	/**
-	 * Indicates whenever a programme is fully online or not
-	 *
-	 * @return boolean
-	 */
-	isFullyOnline(): boolean;
-}

package/src/models/bestfit-programme/i-city.ts

@@ -1,16 +0,0 @@
-export interface ICity {
-
-	/**
-	 * Get city id
-	 *
-	 * @return number
-	 */
-	getId(): number;
-
-	/**
-	 * Get city name
-	 *
-	 * @return string
-	 */
-	getName(): string;
-}

package/src/models/bestfit-programme/i-living-cost.ts

@@ -1,23 +0,0 @@
-export interface ILivingCost {
-
-	/**
-	 * Get the applicable currency.
-	 *
-	 * @return string
-	 */
-	getCurrency(): string;
-
-	/**
-	 * Get the maximum living cost in the provided currency.
-	 *
-	 * @return number
-	 */
-	getMax(): number;
-
-	/**
-	 * Get the minimum living cost in the provided currency.
-	 *
-	 * @return number
-	 */
-	getMin(): number;
-}

package/src/models/common/i-city.ts

@@ -1,16 +0,0 @@
-export interface ICity {
-
-	/**
-	 * Get city id
-	 *
-	 * @return number
-	 */
-	getId(): number;
-
-	/**
-	 * Get city name
-	 *
-	 * @return string
-	 */
-	getName(): string;
-}

package/src/models/common/i-country.ts

@@ -1,23 +0,0 @@
-export interface ICountry {
-
-	/**
-	 * Get country iso code
-	 *
-	 * @return string
-	 */
-	getISOCode(): string;
-
-	/**
-	 * Get country id
-	 *
-	 * @return number
-	 */
-	getId(): number;
-
-	/**
-	 * Get country name
-	 *
-	 * @return string
-	 */
-	getName(): string;
-}

package/src/models/common/i-english-requirements.ts

@@ -1,56 +0,0 @@
-export interface IEnglishRequirements {
-
-	/**
-	 * Required score for Cambridge english
-	 *
-	 * @return number
-	 */
-	getCambridgeEnglish(): number;
-
-	canShowCambridgeEnglish(): boolean;
-
-	/**
-	 * Required score for Duolingo
-	 *
-	 * @return number
-	 */
-	getDuolingo(): number;
-
-	canShowDuolingo(): boolean;
-
-	/**
-	 * Required score for IELTS tests
-	 *
-	 * @return number
-	 */
-	getIELTS(): number;
-
-	canShowIELTS(): boolean;
-
-	/**
-	 * Required score for PTE
-	 *
-	 * @return number
-	 */
-	getPTE(): number;
-
-	canShowPTE(): boolean;
-
-	/**
-	 * Required score for TOEFL internet
-	 *
-	 * @return number
-	 */
-	getTOEFLInternet(): number;
-
-	canShowTOEFLInternet(): boolean;
-
-	/**
-	 * Required score for TOEFL paper
-	 *
-	 * @return number
-	 */
-	getTOEFLPaper(): number;
-
-	canShowTOEFLPaper(): boolean;
-}

package/src/models/common/i-g-p-a-requirement.ts

@@ -1,23 +0,0 @@
-export interface IGPARequirement {
-
-	/**
-	 * The used GPA scale for this requirement
-	 *
-	 * @return string
-	 */
-	getScale(): string;
-
-	/**
-	 * Required minimum score.
-	 *
-	 * @return string
-	 */
-	getScore(): string;
-
-	/**
-	 * Is GPA recommended or required.
-	 *
-	 * @return boolean
-	 */
-	isRequired(): boolean;
-}

package/src/models/common/i-internal-link.ts

@@ -1,32 +0,0 @@
-export interface IInternalLink {
-
-	/**
-	 * Get an optional text describing the link (typically <a>-tags contents).
-	 *
-	 * @return string
-	 * @throws PropertyNotAvailableException
-	 */
-	getDescription(): string;
-
-	canShowDescription(): boolean;
-
-	/**
-	 * Returns on which portal a this link should link towards.
-	 *
-	 * @return string
-	 */
-	getPortalType(): string;
-
-	/**
-	 * Get the url to refer to.
-	 *
-	 * Note that the url provided is always a relative URL. A base URL is needed
-	 * to make it a full valid path.
-	 * The only exception is when an external link is provided (meaning, outside
-	 * of StudyPortals-maintained domains). In this case a full url will be
-	 * provided.
-	 *
-	 * @return string
-	 */
-	getUrl(): string;
-}

package/src/models/common/i-logo.ts

@@ -1,16 +0,0 @@
-export interface ILogo {
-
-	/**
-	 * Get the file ID of the logo.
-	 *
-	 * @return number
-	 */
-	getId(): number;
-
-	/**
-	 * Get the imgix URL of the logo.
-	 *
-	 * @return string
-	 */
-	getSource(): string;
-}

package/src/models/common/i-tuition-fee.ts

@@ -1,57 +0,0 @@
-export interface ITuitionFee {
-
-	/**
-	 * Get the tuition amount per unit in the provided currency.
-	 *
-	 * Note: all transformable units will be converted to yearly amounts. This
-	 * includes per semester and full programme tuition fees.
-	 *
-	 * @return number
-	 */
-	getAmount(): number;
-
-	/**
-	 * Get the applicable currency.
-	 *
-	 * @return string
-	 */
-	getCurrency(): string;
-
-	/**
-	 * Get the original tuition amount before any transformation step.
-	 *
-	 * @return number
-	 */
-	getOriginalAmount(): number;
-
-	/**
-	 * Get the original tuition unit before any transformation step.
-	 *
-	 * @return string
-	 */
-	getOriginalUnit(): string;
-
-	/**
-	 * Get targeted audience (national, international, eea, etc).
-	 *
-	 * @return string
-	 */
-	getTarget(): string;
-
-	/**
-	 * Get the unit the tuition fee applies for.
-	 *
-	 * Note: all transformable units will be converted to 'year'. This means
-	 * this value will be either 'year', 'module' or 'credit'.
-	 *
-	 * @return string
-	 */
-	getUnit(): string;
-
-	/**
-	 * True if the study is free for this target audience.
-	 *
-	 * @return boolean
-	 */
-	isFree(): boolean;
-}

package/src/models/compare-programme/compare-programme-client.ts

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

package/src/models/compare-programme/i-compare-programme.ts

@@ -1,126 +0,0 @@
-import { IDuration, IEnglishRequirements, IGPARequirement, IInternalLink, ILink, ILivingCost, ILocation, ITiming, ITuitionFee } from "../../..";
-
-export interface ICompareProgramme {
-
-	/**
-	 * Degree of programme
-	 *
-	 * @return string
-	 */
-	getDegree(): string;
-
-	/**
-	 * Duration of the programme
-	 *
-	 * @return IDuration | null
-	 */
-	getDuration(): IDuration | null;
-
-	/**
-	 * English level requirements.
-	 *
-	 * @return IEnglishRequirements
-	 */
-	getEnglishRequirements(): IEnglishRequirements;
-
-	/**
-	 * GPA requirements
-	 *
-	 * @return IGPARequirement | null
-	 */
-	getGPA(): IGPARequirement | null;
-
-	/**
-	 * Id of the programme.
-	 *
-	 * @return number
-	 */
-	getId(): number;
-
-	/**
-	 * Estimated living cost based on universities' location.
-	 *
-	 * @return ILivingCost | null
-	 */
-	getLivingCost(): ILivingCost | null;
-
-	/**
-	 * Indicates where a programme is taught
-	 *
-	 * @return ILocation | null
-	 */
-	getLocation(): ILocation | null;
-
-	/**
-	 * Get a link to the programme page.
-	 *
-	 * The link contains the page path as url and the programme name as the
-	 * link description.
-	 *
-	 * @return IInternalLink
-	 */
-	getProgrammeLink(): IInternalLink;
-
-	/**
-	 * The universities review quantity
-	 *
-	 * @return number | null
-	 */
-	getReviewQuantity(): number | null;
-
-	/**
-	 * The universities review rating
-	 *
-	 * @return number | null
-	 */
-	getReviewRating(): number | null;
-
-	/**
-	 * Get all start dates
-	 *
-	 * @return ITiming[]
-	 */
-	getTimings(): ITiming[];
-
-	/**
-	 * Title of the programme.
-	 *
-	 * @return string
-	 */
-	getTitle(): string;
-
-	/**
-	 * The programmes tuition fees
-	 *
-	 * @return ITuitionFee[]
-	 */
-	getTuitionFees(): ITuitionFee[];
-
-	/**
-	 * Returns a link to the university
-	 *
-	 * @return ILink
-	 */
-	getUniversityLink(): ILink;
-
-	/**
-	 * Amount of years required as work experience
-	 *
-	 * @return number | null
-	 */
-	getWorkExperienceYears(): number | null;
-
-	/**
-	 * Indicates whenever a programme is fully online or not
-	 *
-	 * @return boolean
-	 */
-	isFullyOnline(): boolean;
-
-	/**
-	 * Is programme public
-	 *
-	 * @return boolean
-	 */
-	isPublic(): boolean;
-}