@studyportals/domain-client 3.5.2-beta.1 → 3.6.0-0

package/src/model-client.d.ts

@@ -1,16 +1,16 @@
-import { IModelDescription } from "./i-model-description";
-import { PortalMap } from "./types/portal-map";
-export declare abstract class ModelClient<T> {
-    private readonly domainClient;
-    private readonly modelFactory;
-    constructor(baseUrl?: string, apiKey?: string, seed?: number, portalMap?: PortalMap);
-    fetch(id: number): Promise<T>;
-    fetchDescription(id: number): Promise<IModelDescription>;
-    fetchMultiple(ids: number[]): Promise<T[]>;
-    fetchMultipleDescriptions(ids: number[]): Promise<IModelDescription[]>;
-    fromDescription(description: IModelDescription): T;
-    fromDescriptions(descriptions: IModelDescription[]): T[];
-    protected abstract getModelName(): string;
-    protected abstract getVersion(): string;
-    abstract isPublic(): boolean;
-}
+import { IModelDescription } from "./i-model-description";
+import { PortalMap } from "./types/portal-map";
+export declare abstract class ModelClient<T> {
+    private readonly domainClient;
+    private readonly modelFactory;
+    constructor(baseUrl?: string, apiKey?: string, seed?: number, portalMap?: PortalMap);
+    fetch(id: number): Promise<T>;
+    fetchDescription(id: number): Promise<IModelDescription>;
+    fetchMultiple(ids: number[]): Promise<T[]>;
+    fetchMultipleDescriptions(ids: number[]): Promise<IModelDescription[]>;
+    fromDescription(description: IModelDescription): T;
+    fromDescriptions(descriptions: IModelDescription[]): T[];
+    protected abstract getModelName(): string;
+    protected abstract getVersion(): string;
+    abstract isPublic(): boolean;
+}

package/src/model-client.js

@@ -1,46 +1,46 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ModelClient = void 0;
-const domain_client_1 = require("./domain-client");
-const client_exception_1 = require("./exceptions/client-exception");
-const model_factory_1 = require("./model-factory");
-class ModelClient {
-    constructor(baseUrl, apiKey, seed, portalMap) {
-        if (!baseUrl || !seed) {
-            return;
-        }
-        this.modelFactory = new model_factory_1.ModelFactory(portalMap);
-        this.domainClient = new domain_client_1.DomainClient(baseUrl, apiKey, this.getModelName(), this.getVersion(), this.isPublic(), seed);
-    }
-    async fetch(id) {
-        const modelDescriptions = await this.fetchDescription(id);
-        return this.modelFactory.fromDescription(modelDescriptions);
-    }
-    async fetchDescription(id) {
-        if (!this.domainClient) {
-            throw new client_exception_1.ClientException("Offline mode active: did you provide all parameters " +
-                "in the constructor?");
-        }
-        const result = await this.domainClient.doRequest([id]);
-        return result[0];
-    }
-    async fetchMultiple(ids) {
-        const descriptions = await this.fetchMultipleDescriptions(ids);
-        return this.modelFactory.fromDescriptions(descriptions);
-    }
-    async fetchMultipleDescriptions(ids) {
-        if (!this.domainClient) {
-            throw new client_exception_1.ClientException('Offline mode active: did you provide all parameters ' +
-                'in the constructor?');
-        }
-        return await this.domainClient.doRequest(ids);
-    }
-    fromDescription(description) {
-        return this.modelFactory.fromDescription(description);
-    }
-    fromDescriptions(descriptions) {
-        return this.modelFactory.fromDescriptions(descriptions);
-    }
-}
-exports.ModelClient = ModelClient;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModelClient = void 0;
+const domain_client_1 = require("./domain-client");
+const client_exception_1 = require("./exceptions/client-exception");
+const model_factory_1 = require("./model-factory");
+class ModelClient {
+    constructor(baseUrl, apiKey, seed, portalMap) {
+        if (!baseUrl || !seed) {
+            return;
+        }
+        this.modelFactory = new model_factory_1.ModelFactory(portalMap);
+        this.domainClient = new domain_client_1.DomainClient(baseUrl, apiKey, this.getModelName(), this.getVersion(), this.isPublic(), seed);
+    }
+    async fetch(id) {
+        const modelDescriptions = await this.fetchDescription(id);
+        return this.modelFactory.fromDescription(modelDescriptions);
+    }
+    async fetchDescription(id) {
+        if (!this.domainClient) {
+            throw new client_exception_1.ClientException("Offline mode active: did you provide all parameters " +
+                "in the constructor?");
+        }
+        const result = await this.domainClient.doRequest([id]);
+        return result[0];
+    }
+    async fetchMultiple(ids) {
+        const descriptions = await this.fetchMultipleDescriptions(ids);
+        return this.modelFactory.fromDescriptions(descriptions);
+    }
+    async fetchMultipleDescriptions(ids) {
+        if (!this.domainClient) {
+            throw new client_exception_1.ClientException('Offline mode active: did you provide all parameters ' +
+                'in the constructor?');
+        }
+        return await this.domainClient.doRequest(ids);
+    }
+    fromDescription(description) {
+        return this.modelFactory.fromDescription(description);
+    }
+    fromDescriptions(descriptions) {
+        return this.modelFactory.fromDescriptions(descriptions);
+    }
+}
+exports.ModelClient = ModelClient;
 //# sourceMappingURL=model-client.js.map

package/src/model-factory.d.ts

@@ -1,11 +1,11 @@
-import { IModelDescription } from "./i-model-description";
-import { PortalMap } from "./types/portal-map";
-export declare class ModelFactory<T> {
-    private customClassFactories;
-    constructor(portalMap?: PortalMap);
-    fromDescription(data: IModelDescription): T;
-    fromDescriptions(data: IModelDescription[]): T[];
-    private unpackClass;
-    private getCallable;
-    private unpackArray;
-}
+import { IModelDescription } from "./i-model-description";
+import { PortalMap } from "./types/portal-map";
+export declare class ModelFactory<T> {
+    private customClassFactories;
+    constructor(portalMap?: PortalMap);
+    fromDescription(data: IModelDescription): T;
+    fromDescriptions(data: IModelDescription[]): T[];
+    private unpackClass;
+    private getCallable;
+    private unpackArray;
+}

package/src/model-factory.js

@@ -1,72 +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 {
-    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 (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 (i_model_description_1.isModelDescription(item)) {
-                return this.unpackClass(item);
-            }
-            return item;
-        });
-    }
-}
-exports.ModelFactory = ModelFactory;
+"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 {
+    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 (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 (i_model_description_1.isModelDescription(item)) {
+                return this.unpackClass(item);
+            }
+            return item;
+        });
+    }
+}
+exports.ModelFactory = ModelFactory;
 //# sourceMappingURL=model-factory.js.map

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

@@ -1,7 +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;
-}
+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

@@ -1,17 +1,17 @@
-"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;
+"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;
 //# sourceMappingURL=bestfit-programme-client.js.map

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

@@ -1,82 +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
-     */
-    getRequiredEducationalLevel(): string;
-    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;
-}
+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
+     */
+    getRequiredEducationalLevel(): string;
+    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

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=i-best-fit-programme.js.map

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

@@ -1,20 +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;
-}
+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/bestfit-programme/i-g-p-a-requirement.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=i-g-p-a-requirement.js.map

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

@@ -1,20 +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;
-}
+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

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=i-living-cost.js.map

package/src/models/{bestfit-programme → common}/i-city.d.ts

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

package/src/models/{bestfit-programme → common}/i-city.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=i-city.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"i-city.js","sourceRoot":"","sources":["../../../../src/models/common/i-city.ts"],"names":[],"mappings":""}