@studyportals/domain-client 7.0.1-beta.5 → 7.1.0

package/src/model-factory.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModelFactory = void 0;
+const InternalLinkFactory_1 = require("./factories/InternalLinkFactory");
+const DateFactory_1 = require("./factories/DateFactory");
+const i_model_description_1 = require("./i-model-description");
+const property_not_available_exception_1 = require("./exceptions/property-not-available-exception");
+class ModelFactory {
+    customClassFactories;
+    constructor(portalMap = new Map()) {
+        const factories = new Map();
+        factories.set('IInternalLink', new InternalLinkFactory_1.InternalLinkFactory(portalMap));
+        factories.set('SerializableDateTime', new DateFactory_1.DateFactory());
+        this.customClassFactories = factories;
+    }
+    fromDescription(data) {
+        return this.unpackClass(data);
+    }
+    fromDescriptions(data) {
+        const models = [];
+        for (const modelDescription of data) {
+            models.push(this.unpackClass(modelDescription));
+        }
+        return models;
+    }
+    unpackClass(data) {
+        const unpacked = {};
+        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;
+    }
+    getCallable(functionName, data) {
+        const propertyName = functionName.substr(3);
+        const canShowFunction = 'canShow' + propertyName;
+        const value = data.func[functionName];
+        let returnValue;
+        if ((0, i_model_description_1.isModelDescription)(value)) {
+            returnValue = this.unpackClass(value);
+        }
+        else if (Array.isArray(value)) {
+            returnValue = this.unpackArray(value);
+        }
+        else {
+            returnValue = value;
+        }
+        if (canShowFunction in data.func) {
+            return () => {
+                if (data.func[canShowFunction] === false) {
+                    throw new property_not_available_exception_1.PropertyNotAvailableException(`Property '${propertyName}' not available`);
+                }
+                return returnValue;
+            };
+        }
+        return () => {
+            return returnValue;
+        };
+    }
+    unpackArray(list) {
+        return list.map(item => {
+            if ((0, i_model_description_1.isModelDescription)(item)) {
+                return this.unpackClass(item);
+            }
+            return item;
+        });
+    }
+}
+exports.ModelFactory = ModelFactory;

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

@@ -0,0 +1,7 @@
+import { IBestFitProgramme } from "../../..";
+import { ModelClient } from "../../model-client";
+export declare class BestfitProgrammeClient extends ModelClient<IBestFitProgramme> {
+    protected getModelName(): string;
+    protected getVersion(): string;
+    isPublic(): boolean;
+}

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

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BestfitProgrammeClient = void 0;
+const model_client_1 = require("../../model-client");
+class BestfitProgrammeClient extends model_client_1.ModelClient {
+    getModelName() {
+        return 'bestfit-programme';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}
+exports.BestfitProgrammeClient = BestfitProgrammeClient;

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

@@ -0,0 +1,82 @@
+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-best-fit-programme.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

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

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,20 @@
+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/bestfit-programme/i-living-cost.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/city-search-document/city-search-document-client.d.ts

@@ -0,0 +1,7 @@
+import { ModelClient } from "../../model-client";
+import { ICitySearchDocument } from "../../..";
+export declare class CitySearchDocumentClient extends ModelClient<ICitySearchDocument> {
+    protected getModelName(): string;
+    protected getVersion(): string;
+    isPublic(): boolean;
+}

package/src/models/city-search-document/city-search-document-client.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CitySearchDocumentClient = void 0;
+const model_client_1 = require("../../model-client");
+class CitySearchDocumentClient extends model_client_1.ModelClient {
+    getModelName() {
+        return 'city-search-document';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}
+exports.CitySearchDocumentClient = CitySearchDocumentClient;

package/src/models/city-search-document/i-city-search-document.d.ts

@@ -0,0 +1,7 @@
+export interface ICitySearchDocument {
+    getId(): number;
+    getName(): string;
+    getVirtualPath(): string;
+    getAreaId(): number | null;
+    getCountryIsoCode(): string;
+}

package/src/models/city-search-document/i-city-search-document.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

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

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,20 @@
+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-country.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,51 @@
+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;
+    /**
+     * Required score for OTE
+     *
+     * @return number
+     */
+    getOte(): number;
+    canShowOte(): boolean;
+}

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,20 @@
+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-g-p-a-requirement.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,28 @@
+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-internal-link.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,14 @@
+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-logo.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/common/i-review-rating.d.ts

@@ -0,0 +1,26 @@
+export interface IReviewRating {
+    /**
+     * The average rating of the reviews on 10-point scale.
+     *
+     * @return number
+     */
+    getAverage(): number;
+    /**
+     * The number of reviews that contributed to the average rating.
+     *
+     * @return number
+     */
+    getQuantity(): number;
+    /**
+     * Checks if the rating has enough reviews to be considered valid.
+     *
+     * @return boolean
+     */
+    hasEnoughQuantity(): boolean;
+    /**
+     * Gets the average star rating based on the average score on 5-point scale.
+     *
+     * @return number
+     */
+    getAverageStarRating(): number;
+}

package/src/models/common/i-review-rating.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,50 @@
+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/common/i-tuition-fee.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/copilot-country/copilot-country-client.d.ts

@@ -0,0 +1,7 @@
+import { ICopilotCountry } from "../../..";
+import { ModelClient } from "../../model-client";
+export declare class CopilotCountryClient extends ModelClient<ICopilotCountry> {
+    protected getModelName(): string;
+    protected getVersion(): string;
+    isPublic(): boolean;
+}

package/src/models/copilot-country/copilot-country-client.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CopilotCountryClient = void 0;
+const model_client_1 = require("../../model-client");
+class CopilotCountryClient extends model_client_1.ModelClient {
+    getModelName() {
+        return 'copilot-country';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}
+exports.CopilotCountryClient = CopilotCountryClient;

package/src/models/copilot-country/i-copilot-country.d.ts

@@ -0,0 +1,39 @@
+import { ICopilotRankingCard } from "./i-copilot-ranking-card";
+export interface ICopilotCountry {
+    /**
+     * How to apply in country x text
+     *
+     * @return string | null
+     */
+    getHowToApplyText(): string | null;
+    /**
+     * Id of the country.
+     *
+     * @return number
+     */
+    getId(): number;
+    /**
+     * ISO code ALPHA-2
+     *
+     * @return string
+     */
+    getIsoCode(): string;
+    /**
+     * Country title
+     *
+     * @return string
+     */
+    getTitle(): string;
+    /**
+     * Why study in country x text
+     *
+     * @return string | null
+     */
+    getWhyText(): string | null;
+    /**
+     * Top universities of the country
+     *
+     * @return ICopilotRankingCard[] | null
+     */
+    getTopUniversities(): ICopilotRankingCard[] | null;
+}

package/src/models/copilot-country/i-copilot-country.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/copilot-country/i-copilot-ranking-card.d.ts

@@ -0,0 +1,38 @@
+export interface ICopilotRankingCard {
+    /**
+     * Get the organisation id.
+     *
+     * @return number
+     */
+    getOrganisationId(): number;
+    /**
+     * Get the organisation name.
+     *
+     * @return string | null
+     */
+    getOrganisationName(): string | null;
+    /**
+     * Get the organisation homepage link.
+     *
+     * @return string | null
+     */
+    getOrganisationPageUrl(): string | null;
+    /**
+     * Get the organisation logo url.
+     *
+     * @return string | null
+     */
+    getOrganisationLogoUrl(): string | null;
+    /**
+     * Verifies if the organisation's logo can be displayed.
+     *
+     * @return boolean
+     */
+    hasOrganisationLogo(): boolean;
+    /**
+     * Retrieves the ranking position for the organisation in the Studyportals ranking in the country of the university.
+     *
+     * @return number | null
+     */
+    getPositionInCountry(): number | null;
+}

package/src/models/copilot-country/i-copilot-ranking-card.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/copilot-programme/copilot-programme-client.d.ts

@@ -0,0 +1,7 @@
+import { ICopilotProgramme } from "../../..";
+import { ModelClient } from "../../model-client";
+export declare class CopilotProgrammeClient extends ModelClient<ICopilotProgramme> {
+    protected getModelName(): string;
+    protected getVersion(): string;
+    isPublic(): boolean;
+}

package/src/models/copilot-programme/copilot-programme-client.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CopilotProgrammeClient = void 0;
+const model_client_1 = require("../../model-client");
+class CopilotProgrammeClient extends model_client_1.ModelClient {
+    getModelName() {
+        return 'copilot-programme';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}
+exports.CopilotProgrammeClient = CopilotProgrammeClient;