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

package/protobuf/index.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @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/protobuf/index.js

@@ -0,0 +1,61 @@
+"use strict";
+/**
+ * @file Automatically generated by barrelsby.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Area"), exports);
+__exportStar(require("./Article"), exports);
+__exportStar(require("./Body"), exports);
+__exportStar(require("./CampaignInformation"), exports);
+__exportStar(require("./ClickTracking"), exports);
+__exportStar(require("./CommercialEntity"), exports);
+__exportStar(require("./Cover"), exports);
+__exportStar(require("./Deadline"), exports);
+__exportStar(require("./Degree"), exports);
+__exportStar(require("./Description"), exports);
+__exportStar(require("./Discipline"), exports);
+__exportStar(require("./Duration"), exports);
+__exportStar(require("./EnglishRequirement"), exports);
+__exportStar(require("./EssentialInformation"), exports);
+__exportStar(require("./File"), exports);
+__exportStar(require("./GPARequirement"), exports);
+__exportStar(require("./InternalLink"), exports);
+__exportStar(require("./Link"), exports);
+__exportStar(require("./LivingCost"), exports);
+__exportStar(require("./Location"), exports);
+__exportStar(require("./Logo"), exports);
+__exportStar(require("./MiniProgrammeCard"), exports);
+__exportStar(require("./OptionalLink"), exports);
+__exportStar(require("./Organisation"), exports);
+__exportStar(require("./OrganisationInformation"), exports);
+__exportStar(require("./OrganisationRanking"), exports);
+__exportStar(require("./Person"), exports);
+__exportStar(require("./ProgrammeCard"), exports);
+__exportStar(require("./ProgrammeGrid"), exports);
+__exportStar(require("./Ranking"), exports);
+__exportStar(require("./RankingInstitute"), exports);
+__exportStar(require("./Review"), exports);
+__exportStar(require("./ReviewRating"), exports);
+__exportStar(require("./RichText"), exports);
+__exportStar(require("./SocialLink"), exports);
+__exportStar(require("./StartDate"), exports);
+__exportStar(require("./Timing"), exports);
+__exportStar(require("./Topic"), exports);
+__exportStar(require("./TrackedLink"), exports);
+__exportStar(require("./Tracking"), exports);
+__exportStar(require("./TuitionFee"), exports);
+__exportStar(require("./Unibuddy"), exports);

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,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArticleDetailPageClient = void 0;
+const protobuf_1 = require("../../protobuf");
+const protobuf_client_1 = require("./protobuf-client");
+class ArticleDetailPageClient extends protobuf_client_1.ProtobufClient {
+    constructModel(data) {
+        return protobuf_1.Article.fromJSON(data);
+    }
+    getModelName() {
+        return 'article-detail-page';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}
+exports.ArticleDetailPageClient = ArticleDetailPageClient;

package/src/clients/index.d.ts

@@ -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/index.js

@@ -0,0 +1,23 @@
+"use strict";
+/**
+ * @file Automatically generated by barrelsby.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./article-detail-page-client"), exports);
+__exportStar(require("./organisation-page-client"), exports);
+__exportStar(require("./protobuf-client"), exports);
+__exportStar(require("./public-mini-programme-card-client"), exports);

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,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrganisationPageClient = void 0;
+const protobuf_1 = require("../../protobuf");
+const protobuf_client_1 = require("./protobuf-client");
+class OrganisationPageClient extends protobuf_client_1.ProtobufClient {
+    constructModel(data) {
+        return protobuf_1.Organisation.fromJSON(data);
+    }
+    getModelName() {
+        return 'organisation-page';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}
+exports.OrganisationPageClient = OrganisationPageClient;

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,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProtobufClient = void 0;
+const domain_client_1 = require("../domain-client");
+class ProtobufClient {
+    static portalMap = new Map();
+    domainClient;
+    constructor(baseUrl, seed, apiKey, portalMap) {
+        if (portalMap) {
+            ProtobufClient.portalMap = portalMap;
+        }
+        this.domainClient = new domain_client_1.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;
+    }
+}
+exports.ProtobufClient = ProtobufClient;

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,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PublicMiniProgrammeCardClient = void 0;
+const protobuf_1 = require("../../protobuf");
+const protobuf_client_1 = require("./protobuf-client");
+class PublicMiniProgrammeCardClient extends protobuf_client_1.ProtobufClient {
+    constructModel(data) {
+        return protobuf_1.MiniProgrammeCard.fromJSON(data);
+    }
+    getModelName() {
+        return 'mini-programme-card';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return true;
+    }
+}
+exports.PublicMiniProgrammeCardClient = PublicMiniProgrammeCardClient;

package/src/domain-client.d.ts

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

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DomainClient = void 0;
+const bad_request_exception_1 = require("./exceptions/bad-request-exception");
+const internal_server_exception_1 = require("./exceptions/internal-server-exception");
+const not_found_exception_1 = require("./exceptions/not-found-exception");
+const decoder = new TextDecoder();
+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 internal_server_exception_1.InternalServerException || error instanceof bad_request_exception_1.BadRequestException || error instanceof not_found_exception_1.NotFoundException) {
+                throw error;
+            }
+            throw new internal_server_exception_1.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 internal_server_exception_1.InternalServerException(response.message);
+        }
+        if (response.status === 400) {
+            throw new bad_request_exception_1.BadRequestException(response.message);
+        }
+        if (response.status === 404) {
+            throw new not_found_exception_1.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;
+    }
+}
+exports.DomainClient = DomainClient;

package/src/exceptions/bad-request-exception.d.ts

@@ -0,0 +1,2 @@
+export declare class BadRequestException extends Error {
+}

package/src/exceptions/bad-request-exception.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BadRequestException = void 0;
+class BadRequestException extends Error {
+}
+exports.BadRequestException = BadRequestException;

package/src/exceptions/client-exception.d.ts

@@ -0,0 +1,2 @@
+export declare class ClientException extends Error {
+}

package/src/exceptions/client-exception.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClientException = void 0;
+class ClientException extends Error {
+}
+exports.ClientException = ClientException;

package/src/exceptions/internal-server-exception.d.ts

@@ -0,0 +1,2 @@
+export declare class InternalServerException extends Error {
+}

package/src/exceptions/internal-server-exception.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InternalServerException = void 0;
+class InternalServerException extends Error {
+}
+exports.InternalServerException = InternalServerException;

package/src/exceptions/not-found-exception.d.ts

@@ -0,0 +1,2 @@
+export declare class NotFoundException extends Error {
+}

package/src/exceptions/not-found-exception.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotFoundException = void 0;
+class NotFoundException extends Error {
+}
+exports.NotFoundException = NotFoundException;

package/src/exceptions/property-not-available-exception.d.ts

@@ -0,0 +1,2 @@
+export declare class PropertyNotAvailableException extends Error {
+}

package/src/exceptions/property-not-available-exception.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PropertyNotAvailableException = void 0;
+class PropertyNotAvailableException extends Error {
+}
+exports.PropertyNotAvailableException = PropertyNotAvailableException;

package/src/factories/DateFactory.d.ts

@@ -0,0 +1,5 @@
+import { IClassFactory } from "../i-class-factory";
+import { CallableReturnType, Model } from "../types";
+export declare class DateFactory implements IClassFactory {
+    create(data: Model, parameters: string[]): CallableReturnType;
+}

package/src/factories/DateFactory.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DateFactory = void 0;
+class DateFactory {
+    create(data, parameters) {
+        return new Date(parameters[0]);
+    }
+}
+exports.DateFactory = DateFactory;

package/src/factories/InternalLinkFactory.d.ts

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

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InternalLinkFactory = void 0;
+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 || '';
+    }
+}
+exports.InternalLinkFactory = InternalLinkFactory;

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

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

package/src/i-api-response.js

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

package/src/i-class-factory.d.ts

@@ -0,0 +1,4 @@
+import { CallableReturnType, Model } from "./types";
+export interface IClassFactory {
+    create(data: Model, parameters?: any[]): CallableReturnType;
+}

package/src/i-class-factory.js

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

package/src/i-model-description.d.ts

@@ -0,0 +1,7 @@
+import { AcceptedType } from "./types";
+export interface IModelDescription {
+    class: string;
+    func: Record<string, AcceptedType | IModelDescription>;
+    parameters?: any[];
+}
+export declare function isModelDescription(arg: any): arg is IModelDescription;

package/src/i-model-description.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isModelDescription = isModelDescription;
+// eslint-disable-next-line
+function isModelDescription(arg) {
+    // eslint-disable-next-line
+    return arg && arg.class && (arg.func || arg.parameters);
+}

package/src/model-client.d.ts

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

package/src/model-client.js

@@ -0,0 +1,47 @@
+"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 {
+    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);
+    }
+    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;

package/src/model-factory.d.ts

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