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

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

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

@@ -0,0 +1,16 @@
+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.ts → index.d.ts}

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

package/src/clients/index.js

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

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

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

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

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

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

@@ -0,0 +1,16 @@
+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/{bin/src → src}/domain-client.d.ts

@@ -1,5 +1,4 @@
-import { IModelDescription } from "./i-model-description";
-export declare class DomainClient {
+export declare class DomainClient<T> {
     readonly baseUrl: string;
     readonly apiKey: string | undefined;
     readonly model: string;
@@ -7,7 +6,8 @@ export declare class DomainClient {
     readonly isPublic: boolean;
     readonly seed: number;
     constructor(baseUrl: string, apiKey: string | undefined, model: string, version: string, isPublic: boolean, seed: number);
-    doRequest(ids: number[]): Promise<IModelDescription[]>;
+    doRequest(ids: number[]): Promise<T[]>;
+    private decompressModelData;
     private handleErrors;
     private buildUrl;
     private shouldAddPublicPrefix;

package/src/domain-client.js

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

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

package/{bin/src → src}/factories/InternalLinkFactory.d.ts

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

package/src/factories/InternalLinkFactory.js

@@ -0,0 +1,22 @@
+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/{bin/src → src}/i-api-response.d.ts

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

package/src/i-api-response.js

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

package/src/i-class-factory.js

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

package/src/i-model-description.js

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

package/{bin/src → src}/model-client.js

@@ -1,16 +1,15 @@
-"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 {
+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 model_factory_1.ModelFactory(portalMap);
-        this.domainClient = new domain_client_1.DomainClient(baseUrl, apiKey, this.getModelName(), this.getVersion(), this.isPublic(), seed);
+        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);
@@ -18,7 +17,7 @@ class ModelClient {
     }
     async fetchDescription(id) {
         if (!this.domainClient) {
-            throw new client_exception_1.ClientException("Offline mode active: did you provide all parameters " +
+            throw new ClientException("Offline mode active: did you provide all parameters " +
                 "in the constructor?");
         }
         const result = await this.domainClient.doRequest([id]);
@@ -30,7 +29,7 @@ class ModelClient {
     }
     async fetchMultipleDescriptions(ids) {
         if (!this.domainClient) {
-            throw new client_exception_1.ClientException('Offline mode active: did you provide all parameters ' +
+            throw new ClientException('Offline mode active: did you provide all parameters ' +
                 'in the constructor?');
         }
         return await this.domainClient.doRequest(ids);
@@ -42,5 +41,3 @@ class ModelClient {
         return this.modelFactory.fromDescriptions(descriptions);
     }
 }
-exports.ModelClient = ModelClient;
-//# sourceMappingURL=model-client.js.map

package/{bin/src → src}/model-factory.js

@@ -1,15 +1,13 @@
-"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 {
+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_1.InternalLinkFactory(portalMap));
-        factories.set('SerializableDateTime', new DateFactory_1.DateFactory());
+        factories.set('IInternalLink', new InternalLinkFactory(portalMap));
+        factories.set('SerializableDateTime', new DateFactory());
         this.customClassFactories = factories;
     }
     fromDescription(data) {
@@ -38,7 +36,7 @@ class ModelFactory {
         const canShowFunction = 'canShow' + propertyName;
         const value = data.func[functionName];
         let returnValue;
-        if ((0, i_model_description_1.isModelDescription)(value)) {
+        if (isModelDescription(value)) {
             returnValue = this.unpackClass(value);
         }
         else if (Array.isArray(value)) {
@@ -50,7 +48,7 @@ class ModelFactory {
         if (canShowFunction in data.func) {
             return () => {
                 if (data.func[canShowFunction] === false) {
-                    throw new property_not_available_exception_1.PropertyNotAvailableException(`Property '${propertyName}' not available`);
+                    throw new PropertyNotAvailableException(`Property '${propertyName}' not available`);
                 }
                 return returnValue;
             };
@@ -61,12 +59,10 @@ class ModelFactory {
     }
     unpackArray(list) {
         return list.map(item => {
-            if ((0, i_model_description_1.isModelDescription)(item)) {
+            if (isModelDescription(item)) {
                 return this.unpackClass(item);
             }
             return item;
         });
     }
 }
-exports.ModelFactory = ModelFactory;
-//# sourceMappingURL=model-factory.js.map

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 @@
+export {};

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

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

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

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

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

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

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

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

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

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

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

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

package/src/models/customerio-organisation/customerio-organisation-client.js

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

package/src/models/customerio-organisation/i-customer-io-organisation.js

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

package/src/models/customerio-organisation/i-review.js

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

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

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

package/src/models/customerio-programme/i-customer-io-programme.js

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

package/src/models/customerio-programme/i-internal-link.js

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

package/src/models/faq-static-content/i-faq-static-content.d.ts

@@ -0,0 +1,9 @@
+import { IFaq } from "./i-faq";
+import { IStaticContentUrl } from "./i-static-content-url";
+export interface IFaqStaticContent {
+    getFaqId(): number | null;
+    getStaticContentId(): number | null;
+    getFaqs(): IFaq[] | null;
+    getStaticContentText(): string | null;
+    getStaticContentUrls(): IStaticContentUrl[] | null;
+}

package/src/models/faq-static-content/i-faq-static-content.js

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

package/src/models/faq-static-content/i-faq.d.ts

@@ -0,0 +1,4 @@
+export interface IFaq {
+    getQuestion(): string;
+    getAnswer(): string;
+}

package/src/models/faq-static-content/i-faq.js

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

package/src/models/faq-static-content/i-static-content-url.d.ts

@@ -0,0 +1,4 @@
+export interface IStaticContentUrl {
+    getUrl(): string;
+    getText(): string;
+}

package/src/models/faq-static-content/i-static-content-url.js

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

package/src/models/faq-static-content/public-faq-static-content-client.d.ts

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

package/src/models/faq-static-content/public-faq-static-content-client.js

@@ -0,0 +1,12 @@
+import { ModelClient } from "../../model-client";
+export class PublicFaqStaticContentClient extends ModelClient {
+    getModelName() {
+        return 'faq-static-content';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return true;
+    }
+}

package/{bin/src → src}/models/organisation-card/i-organisation-card.d.ts

@@ -1,3 +1,4 @@
+import { IReviewRating } from "../common/i-review-rating";
 import { IRankingDiscipline } from "./i-ranking-discipline";
 export interface IOrganisationCard {
     getNumberOfProgrammesForBachelors(): number;
@@ -33,4 +34,5 @@ export interface IOrganisationCard {
     isNonProfitFunding(): boolean;
     isPublicFunding(): boolean;
     getCampaignType(): number;
+    getReviewRating(): IReviewRating | null;
 }

package/src/models/organisation-card/i-organisation-card.js

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