@studyportals/domain-client 6.0.0-0 → 6.0.0-10

package/protobuf/index.js

@@ -1,7 +1,45 @@
-/**
- * @file Automatically generated by barrelsby.
- */
-export * from "./InternalLink";
-export * from "./Link";
-export * from "./MiniProgrammeCard";
-//# sourceMappingURL=index.js.map
+/**
+ * @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

@@ -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.d.ts

@@ -1 +1,7 @@
-export * from './mini-programme-card-client';
+/**
+ * @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,2 +1,7 @@
-export * from './mini-programme-card-client';
-//# sourceMappingURL=index.js.map
+/**
+ * @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

@@ -1,11 +1,14 @@
-import { PortalMap } from "../types/portal-map";
-export declare abstract class ProtobufClient<T> {
-    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;
-}
+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,16 +1,26 @@
-import { DomainClient } from "../domain-client";
-export class ProtobufClient {
-    domainClient;
-    constructor(baseUrl, seed, apiKey, 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));
-    }
-}
-//# sourceMappingURL=protobuf-client.js.map
+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/{mini-programme-card-client.d.ts → public-mini-programme-card-client.d.ts}

@@ -1,8 +1,8 @@
-import { ProtobufClient } from "./protobuf-client";
-import { MiniProgrammeCard } from "../../protobuf/MiniProgrammeCard";
-export declare class MiniProgrammeCardClient extends ProtobufClient<MiniProgrammeCard> {
-    protected constructModel(data: Record<string, any>): MiniProgrammeCard;
-    protected getModelName(): string;
-    protected getVersion(): string;
-    isPublic(): boolean;
-}
+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/{mini-programme-card-client.js → public-mini-programme-card-client.js}

@@ -1,17 +1,16 @@
-import { ProtobufClient } from "./protobuf-client";
-import { MiniProgrammeCard } from "../../protobuf/MiniProgrammeCard";
-export class MiniProgrammeCardClient extends ProtobufClient {
-    constructModel(data) {
-        return MiniProgrammeCard.fromJSON(data);
-    }
-    getModelName() {
-        return 'mini-programme-card';
-    }
-    getVersion() {
-        return 'v1';
-    }
-    isPublic() {
-        return true;
-    }
-}
-//# sourceMappingURL=mini-programme-card-client.js.map
+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 +1,14 @@
-import { IModelDescription } from "./i-model-description";
-export declare class DomainClient {
-    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<IModelDescription[]>;
-    private handleErrors;
-    private buildUrl;
-    private shouldAddPublicPrefix;
-}
+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 decompressData;
+    private handleErrors;
+    private buildUrl;
+    private shouldAddPublicPrefix;
+}

package/src/domain-client.js

@@ -1,63 +1,89 @@
-import Axios from "axios";
-import { BadRequestException } from "./exceptions/bad-request-exception";
-import { InternalServerException } from "./exceptions/internal-server-exception";
-import { NotFoundException } from "./exceptions/not-found-exception";
-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.buildUrl(ids);
-        const config = { baseURL: this.baseUrl };
-        if (this.apiKey !== undefined) {
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-            config["headers"] = { 'x-api-key': this.apiKey };
-        }
-        const axiosResponse = await Axios.get(url, config);
-        const response = axiosResponse.data;
-        this.handleErrors(response);
-        const models = [];
-        for (const id of ids) {
-            const modelData = response.data[id];
-            if (!modelData) {
-                continue;
-            }
-            models.push(modelData);
-        }
-        return models;
-    }
-    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;
-    }
-}
-//# sourceMappingURL=domain-client.js.map
+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 });
+            const data = await response.json();
+            if (!response.ok || data.status !== 200) {
+                this.handleErrors(data);
+            }
+            const models = [];
+            for (const id of ids) {
+                let modelData = data.data[id];
+                if (typeof modelData === 'string') {
+                    try {
+                        const bytes = Uint8Array.from(Buffer.from(modelData, 'base64'));
+                        const decompressedBytes = await this.decompressData(bytes);
+                        modelData = JSON.parse(decoder.decode(decompressedBytes));
+                    }
+                    catch (error) {
+                        console.error(error);
+                        continue;
+                    }
+                }
+                if (!modelData) {
+                    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 decompressData(compressedData) {
+        const stream = new DecompressionStream('deflate');
+        const response = new Response(compressedData);
+        const decompressed = response.body?.pipeThrough(stream);
+        return new Uint8Array(await new Response(decompressed).arrayBuffer());
+    }
+    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/exceptions/bad-request-exception.d.ts

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

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

@@ -1,3 +1,2 @@
-export class BadRequestException extends Error {
-}
-//# sourceMappingURL=bad-request-exception.js.map
+export class BadRequestException extends Error {
+}

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

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

package/src/exceptions/client-exception.js

@@ -1,3 +1,2 @@
-export class ClientException extends Error {
-}
-//# sourceMappingURL=client-exception.js.map
+export class ClientException extends Error {
+}

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

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

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

@@ -1,3 +1,2 @@
-export class InternalServerException extends Error {
-}
-//# sourceMappingURL=internal-server-exception.js.map
+export class InternalServerException extends Error {
+}

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

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

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

@@ -1,3 +1,2 @@
-export class NotFoundException extends Error {
-}
-//# sourceMappingURL=not-found-exception.js.map
+export class NotFoundException extends Error {
+}

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

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

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

@@ -1,3 +1,2 @@
-export class PropertyNotAvailableException extends Error {
-}
-//# sourceMappingURL=property-not-available-exception.js.map
+export class PropertyNotAvailableException extends Error {
+}

package/src/factories/DateFactory.d.ts

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

@@ -1,6 +1,5 @@
-export class DateFactory {
-    create(data, parameters) {
-        return new Date(parameters[0]);
-    }
-}
-//# sourceMappingURL=DateFactory.js.map
+export class DateFactory {
+    create(data, parameters) {
+        return new Date(parameters[0]);
+    }
+}

package/src/factories/InternalLinkFactory.d.ts

@@ -1,9 +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): CallableReturnType;
-    private getPortalBaseUrl;
-}
+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,17 +1,21 @@
-export class InternalLinkFactory {
-    portalMap;
-    constructor(portalMap) {
-        this.portalMap = portalMap;
-    }
-    create(link) {
-        const portalBaseUrl = this.getPortalBaseUrl(link.getPortalType());
-        const path = link['getUrl']();
-        link['getUrl'] = () => portalBaseUrl + path;
-        return link;
-    }
-    getPortalBaseUrl(portalType) {
-        const url = this.portalMap.get(portalType);
-        return url || '';
-    }
-}
-//# sourceMappingURL=InternalLinkFactory.js.map
+export class InternalLinkFactory {
+    portalMap;
+    constructor(portalMap) {
+        this.portalMap = portalMap;
+    }
+    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 +1,6 @@
-import { IModelDescription } from "./i-model-description";
-export interface IApiResponse {
-    status: number;
-    data: Record<number, IModelDescription>;
-    message: string;
-}
+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,2 +1 @@
-export {};
-//# sourceMappingURL=i-api-response.js.map
+export {};

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

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

package/src/i-class-factory.js

@@ -1,2 +1 @@
-export {};
-//# sourceMappingURL=i-class-factory.js.map
+export {};

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

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