@studyportals/domain-client 6.0.0 → 6.1.0-beta.0

package/protobuf/index.js

@@ -1,45 +0,0 @@
-/**
- * @file Automatically generated by barrelsby.
- */
-export * from "./Area";
-export * from "./Article";
-export * from "./Body";
-export * from "./CampaignInformation";
-export * from "./ClickTracking";
-export * from "./CommercialEntity";
-export * from "./Cover";
-export * from "./Deadline";
-export * from "./Degree";
-export * from "./Description";
-export * from "./Discipline";
-export * from "./Duration";
-export * from "./EnglishRequirement";
-export * from "./EssentialInformation";
-export * from "./File";
-export * from "./GPARequirement";
-export * from "./InternalLink";
-export * from "./Link";
-export * from "./LivingCost";
-export * from "./Location";
-export * from "./Logo";
-export * from "./MiniProgrammeCard";
-export * from "./OptionalLink";
-export * from "./Organisation";
-export * from "./OrganisationInformation";
-export * from "./OrganisationRanking";
-export * from "./Person";
-export * from "./ProgrammeCard";
-export * from "./ProgrammeGrid";
-export * from "./Ranking";
-export * from "./RankingInstitute";
-export * from "./Review";
-export * from "./ReviewRating";
-export * from "./RichText";
-export * from "./SocialLink";
-export * from "./StartDate";
-export * from "./Timing";
-export * from "./Topic";
-export * from "./TrackedLink";
-export * from "./Tracking";
-export * from "./TuitionFee";
-export * from "./Unibuddy";

package/src/clients/article-detail-page-client.d.ts

@@ -1,8 +0,0 @@
-import { Article } from "../../protobuf";
-import { ProtobufClient } from "./protobuf-client";
-export declare class ArticleDetailPageClient extends ProtobufClient<Article> {
-    protected constructModel(data: Record<string, any>): Article;
-    protected getModelName(): string;
-    protected getVersion(): string;
-    isPublic(): boolean;
-}

package/src/clients/article-detail-page-client.js

@@ -1,16 +0,0 @@
-import { Article } from "../../protobuf";
-import { ProtobufClient } from "./protobuf-client";
-export class ArticleDetailPageClient extends ProtobufClient {
-    constructModel(data) {
-        return Article.fromJSON(data);
-    }
-    getModelName() {
-        return 'article-detail-page';
-    }
-    getVersion() {
-        return 'v1';
-    }
-    isPublic() {
-        return false;
-    }
-}

package/src/clients/index.d.ts

@@ -1,7 +0,0 @@
-/**
- * @file Automatically generated by barrelsby.
- */
-export * from "./article-detail-page-client";
-export * from "./organisation-page-client";
-export * from "./protobuf-client";
-export * from "./public-mini-programme-card-client";

package/src/clients/index.js

@@ -1,7 +0,0 @@
-/**
- * @file Automatically generated by barrelsby.
- */
-export * from "./article-detail-page-client";
-export * from "./organisation-page-client";
-export * from "./protobuf-client";
-export * from "./public-mini-programme-card-client";

package/src/clients/organisation-page-client.d.ts

@@ -1,8 +0,0 @@
-import { Organisation } from "../../protobuf";
-import { ProtobufClient } from "./protobuf-client";
-export declare class OrganisationPageClient extends ProtobufClient<Organisation> {
-    protected constructModel(data: Record<string, any>): Organisation;
-    protected getModelName(): string;
-    protected getVersion(): string;
-    isPublic(): boolean;
-}

package/src/clients/organisation-page-client.js

@@ -1,16 +0,0 @@
-import { Organisation } from "../../protobuf";
-import { ProtobufClient } from "./protobuf-client";
-export class OrganisationPageClient extends ProtobufClient {
-    constructModel(data) {
-        return Organisation.fromJSON(data);
-    }
-    getModelName() {
-        return 'organisation-page';
-    }
-    getVersion() {
-        return 'v1';
-    }
-    isPublic() {
-        return false;
-    }
-}

package/src/clients/protobuf-client.d.ts

@@ -1,14 +0,0 @@
-import { PortalMap } from "../types/portal-map";
-import { PortalType } from "../types/portal-type";
-export declare abstract class ProtobufClient<T> {
-    static portalMap: PortalMap;
-    private readonly domainClient;
-    constructor(baseUrl: string, seed: number, apiKey?: string, portalMap?: PortalMap);
-    fetch(id: number): Promise<T>;
-    fetchMultiple(ids: number[]): Promise<T[]>;
-    protected abstract constructModel(data: Record<string, any>): T;
-    protected abstract getModelName(): string;
-    protected abstract getVersion(): string;
-    abstract isPublic(): boolean;
-    static transformUrlUsingPortalMap(path: string, portalType: PortalType): string;
-}

package/src/clients/protobuf-client.js

@@ -1,26 +0,0 @@
-import { DomainClient } from "../domain-client";
-export class ProtobufClient {
-    static portalMap = new Map();
-    domainClient;
-    constructor(baseUrl, seed, apiKey, portalMap) {
-        if (portalMap) {
-            ProtobufClient.portalMap = portalMap;
-        }
-        this.domainClient = new DomainClient(baseUrl, apiKey, this.getModelName(), this.getVersion(), this.isPublic(), seed);
-    }
-    async fetch(id) {
-        const results = await this.domainClient.doRequest([id]);
-        return this.constructModel(results[0]);
-    }
-    async fetchMultiple(ids) {
-        const results = await this.domainClient.doRequest(ids);
-        return results.map((data) => this.constructModel(data));
-    }
-    static transformUrlUsingPortalMap(path, portalType) {
-        const baseUrl = ProtobufClient.portalMap.get(portalType);
-        if (baseUrl && !path.includes('https')) {
-            return baseUrl + path;
-        }
-        return path;
-    }
-}

package/src/clients/public-mini-programme-card-client.d.ts

@@ -1,8 +0,0 @@
-import { MiniProgrammeCard } from "../../protobuf";
-import { ProtobufClient } from "./protobuf-client";
-export declare class PublicMiniProgrammeCardClient extends ProtobufClient<MiniProgrammeCard> {
-    protected constructModel(data: Record<string, any>): MiniProgrammeCard;
-    protected getModelName(): string;
-    protected getVersion(): string;
-    isPublic(): boolean;
-}

package/src/clients/public-mini-programme-card-client.js

@@ -1,16 +0,0 @@
-import { MiniProgrammeCard } from "../../protobuf";
-import { ProtobufClient } from "./protobuf-client";
-export class PublicMiniProgrammeCardClient extends ProtobufClient {
-    constructModel(data) {
-        return MiniProgrammeCard.fromJSON(data);
-    }
-    getModelName() {
-        return 'mini-programme-card';
-    }
-    getVersion() {
-        return 'v1';
-    }
-    isPublic() {
-        return true;
-    }
-}

package/src/domain-client.d.ts

@@ -1,14 +0,0 @@
-export declare class DomainClient<T> {
-    readonly baseUrl: string;
-    readonly apiKey: string | undefined;
-    readonly model: string;
-    readonly version: string;
-    readonly isPublic: boolean;
-    readonly seed: number;
-    constructor(baseUrl: string, apiKey: string | undefined, model: string, version: string, isPublic: boolean, seed: number);
-    doRequest(ids: number[]): Promise<T[]>;
-    private decompressModelData;
-    private handleErrors;
-    private buildUrl;
-    private shouldAddPublicPrefix;
-}

package/src/domain-client.js

@@ -1,91 +0,0 @@
-import { BadRequestException } from "./exceptions/bad-request-exception";
-import { InternalServerException } from "./exceptions/internal-server-exception";
-import { NotFoundException } from "./exceptions/not-found-exception";
-const decoder = new TextDecoder();
-export class DomainClient {
-    baseUrl;
-    apiKey;
-    model;
-    version;
-    isPublic;
-    seed;
-    constructor(baseUrl, apiKey, model, version, isPublic, seed) {
-        this.baseUrl = baseUrl;
-        this.apiKey = apiKey;
-        this.model = model;
-        this.version = version;
-        this.isPublic = isPublic;
-        this.seed = seed;
-    }
-    async doRequest(ids) {
-        const url = `${this.baseUrl}/${this.buildUrl(ids)}`;
-        const headers = {};
-        if (this.apiKey !== undefined) {
-            headers["x-api-key"] = this.apiKey;
-        }
-        try {
-            const response = await fetch(url, { headers });
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-            const data = await response.json();
-            if (!response.ok || data.status !== 200) {
-                this.handleErrors(data);
-            }
-            const models = [];
-            for (const id of ids) {
-                const modelData = data.data[id];
-                if (!modelData) {
-                    continue;
-                }
-                if (typeof modelData === 'string') {
-                    try {
-                        models.push(await this.decompressModelData(modelData));
-                        continue;
-                    }
-                    catch (error) {
-                        console.error(error);
-                        continue;
-                    }
-                }
-                models.push(modelData);
-            }
-            return models;
-        }
-        catch (error) {
-            console.error('Error fetching data from API:', error);
-            if (error instanceof InternalServerException || error instanceof BadRequestException || error instanceof NotFoundException) {
-                throw error;
-            }
-            throw new InternalServerException('Unable to fetch data from the API', error);
-        }
-    }
-    async decompressModelData(compressedData) {
-        const bytes = Uint8Array.from(atob(compressedData), c => c.charCodeAt(0));
-        const stream = new DecompressionStream('deflate');
-        const response = new Response(bytes);
-        const decompressedStream = response.body?.pipeThrough(stream);
-        const decompressedBytes = new Uint8Array(await new Response(decompressedStream).arrayBuffer());
-        return JSON.parse(decoder.decode(decompressedBytes));
-    }
-    handleErrors(response) {
-        if (!response.status) {
-            throw new InternalServerException(response.message);
-        }
-        if (response.status === 400) {
-            throw new BadRequestException(response.message);
-        }
-        if (response.status === 404) {
-            throw new NotFoundException(response.message);
-        }
-    }
-    buildUrl(ids) {
-        const publicPrefix = this.shouldAddPublicPrefix() ? 'public/' : '';
-        let query = `${publicPrefix}${this.model}/${this.version}/?seed=${this.seed}`;
-        for (const id of ids) {
-            query += `&id=${id}`;
-        }
-        return query;
-    }
-    shouldAddPublicPrefix() {
-        return this.isPublic && this.apiKey === undefined;
-    }
-}

package/src/factories/DateFactory.js

@@ -1,5 +0,0 @@
-export class DateFactory {
-    create(data, parameters) {
-        return new Date(parameters[0]);
-    }
-}

package/src/factories/InternalLinkFactory.d.ts

@@ -1,9 +0,0 @@
-import { IClassFactory } from "../i-class-factory";
-import { CallableReturnType, Model } from "../types";
-import { PortalMap } from "../types/portal-map";
-export declare class InternalLinkFactory implements IClassFactory {
-    private portalMap;
-    constructor(portalMap: PortalMap);
-    create(link: Model, parameters?: unknown): CallableReturnType;
-    private getPortalBaseUrl;
-}

package/src/factories/InternalLinkFactory.js

@@ -1,22 +0,0 @@
-export class InternalLinkFactory {
-    portalMap;
-    constructor(portalMap) {
-        this.portalMap = portalMap;
-    }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    create(link, parameters) {
-        const getPortalType = link['getPortalType'];
-        const portalType = getPortalType ? getPortalType() : null;
-        const portalBaseUrl = portalType ? this.getPortalBaseUrl(portalType) : '';
-        const getUrl = link['getUrl'];
-        if (getUrl) {
-            const path = getUrl();
-            link['getUrl'] = () => portalBaseUrl + path;
-        }
-        return link;
-    }
-    getPortalBaseUrl(portalType) {
-        const url = this.portalMap.get(portalType);
-        return url || '';
-    }
-}

package/src/i-api-response.d.ts

@@ -1,6 +0,0 @@
-import { IModelDescription } from "./i-model-description";
-export interface IApiResponse {
-    status: number;
-    data: Record<number, IModelDescription | string>;
-    message: string;
-}

package/src/i-api-response.js

@@ -1 +0,0 @@
-export {};

package/src/i-class-factory.js

@@ -1 +0,0 @@
-export {};

package/src/i-model-description.js

@@ -1,5 +0,0 @@
-// eslint-disable-next-line
-export function isModelDescription(arg) {
-    // eslint-disable-next-line
-    return arg && arg.class && (arg.func || arg.parameters);
-}

package/src/model-client.js

@@ -1,43 +0,0 @@
-import { DomainClient } from "./domain-client";
-import { ClientException } from "./exceptions/client-exception";
-import { ModelFactory } from "./model-factory";
-export class ModelClient {
-    domainClient;
-    modelFactory;
-    constructor(baseUrl, apiKey, seed, portalMap) {
-        if (!baseUrl || !seed) {
-            return;
-        }
-        this.modelFactory = new ModelFactory(portalMap);
-        this.domainClient = new 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 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 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);
-    }
-}

package/src/model-factory.js

@@ -1,68 +0,0 @@
-import { InternalLinkFactory } from "./factories/InternalLinkFactory";
-import { DateFactory } from "./factories/DateFactory";
-import { isModelDescription } from "./i-model-description";
-import { PropertyNotAvailableException } from "./exceptions/property-not-available-exception";
-export class ModelFactory {
-    customClassFactories;
-    constructor(portalMap = new Map()) {
-        const factories = new Map();
-        factories.set('IInternalLink', new InternalLinkFactory(portalMap));
-        factories.set('SerializableDateTime', new 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 (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 PropertyNotAvailableException(`Property '${propertyName}' not available`);
-                }
-                return returnValue;
-            };
-        }
-        return () => {
-            return returnValue;
-        };
-    }
-    unpackArray(list) {
-        return list.map(item => {
-            if (isModelDescription(item)) {
-                return this.unpackClass(item);
-            }
-            return item;
-        });
-    }
-}

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

@@ -1,12 +0,0 @@
-import { ModelClient } from "../../model-client";
-export class BestfitProgrammeClient extends ModelClient {
-    getModelName() {
-        return 'bestfit-programme';
-    }
-    getVersion() {
-        return 'v1';
-    }
-    isPublic() {
-        return false;
-    }
-}

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

@@ -1 +0,0 @@
-export {};

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

@@ -1 +0,0 @@
-export {};

package/src/models/bestfit-programme/i-english-requirements.d.ts

@@ -1,51 +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 OTE
-     *
-     * @return number
-     */
-    getOte(): number;
-    canShowOte(): 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/bestfit-programme/i-english-requirements.js

@@ -1 +0,0 @@
-export {};

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

@@ -1 +0,0 @@
-export {};

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

@@ -1 +0,0 @@
-export {};

package/src/models/bestfit-programme/i-tuition-fee.js

@@ -1 +0,0 @@
-export {};

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

@@ -1 +0,0 @@
-export {};

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

@@ -1 +0,0 @@
-export {};

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

@@ -1 +0,0 @@
-export {};

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

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

@@ -1 +0,0 @@
-export {};

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

@@ -1 +0,0 @@
-export {};

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

@@ -1 +0,0 @@
-export {};

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

@@ -1,26 +0,0 @@
-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

@@ -1 +0,0 @@
-export {};

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

@@ -1 +0,0 @@
-export {};