@studyportals/domain-client 8.3.1 → 8.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@studyportals/domain-client",
-	"version": "8.3.1",
+	"version": "8.4.0",
 	"description": "Responsible for fetching data from the Domain API",
 	"type": "module",
 	"main": "index.js",

package/protobuf/Organisation/OrganisationCard.d.ts

@@ -0,0 +1,42 @@
+import { Location } from "../Location.js";
+import { ReviewRating } from "../ReviewRating.js";
+export interface OrganisationCard {
+    id: number;
+    name: string;
+    summary?: string | undefined;
+    relativeUrlPath: string;
+    logoUrl?: string | undefined;
+    locations: Location[];
+    hasAttendanceOnline: boolean;
+    hasAttendanceOnCampus: boolean;
+    hasAttendanceBlended: boolean;
+    venueCount: number;
+    globalRankingPositionPercentage?: string | undefined;
+    globalRankingPosition?: number | undefined;
+    programmeCountByLevel: {
+        [key: string]: number;
+    };
+    scholarshipCountByLevel: {
+        [key: string]: number;
+    };
+    isPublicFunding: boolean;
+    isNonProfitFunding: boolean;
+    isForProfitFunding: boolean;
+    reviewRating?: ReviewRating | undefined;
+}
+export interface OrganisationCard_ProgrammeCountByLevelEntry {
+    key: string;
+    value: number;
+}
+export interface OrganisationCard_ScholarshipCountByLevelEntry {
+    key: string;
+    value: number;
+}
+export declare const OrganisationCard: MessageFns<OrganisationCard>;
+export declare const OrganisationCard_ProgrammeCountByLevelEntry: MessageFns<OrganisationCard_ProgrammeCountByLevelEntry>;
+export declare const OrganisationCard_ScholarshipCountByLevelEntry: MessageFns<OrganisationCard_ScholarshipCountByLevelEntry>;
+interface MessageFns<T> {
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+}
+export {};

package/protobuf/Organisation/OrganisationCard.js

@@ -0,0 +1,164 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.7.7
+//   protoc               v6.33.2
+// source: Organisation/OrganisationCard.proto
+/* eslint-disable */
+import { Location } from "../Location.js";
+import { ReviewRating } from "../ReviewRating.js";
+export const OrganisationCard = {
+    fromJSON(object) {
+        return {
+            id: isSet(object.id) ? globalThis.Number(object.id) : 0,
+            name: isSet(object.name) ? globalThis.String(object.name) : "",
+            summary: isSet(object.summary) ? globalThis.String(object.summary) : undefined,
+            relativeUrlPath: isSet(object.relativeUrlPath) ? globalThis.String(object.relativeUrlPath) : "",
+            logoUrl: isSet(object.logoUrl) ? globalThis.String(object.logoUrl) : undefined,
+            locations: globalThis.Array.isArray(object?.locations)
+                ? object.locations.map((e) => Location.fromJSON(e))
+                : [],
+            hasAttendanceOnline: isSet(object.hasAttendanceOnline) ? globalThis.Boolean(object.hasAttendanceOnline) : false,
+            hasAttendanceOnCampus: isSet(object.hasAttendanceOnCampus)
+                ? globalThis.Boolean(object.hasAttendanceOnCampus)
+                : false,
+            hasAttendanceBlended: isSet(object.hasAttendanceBlended)
+                ? globalThis.Boolean(object.hasAttendanceBlended)
+                : false,
+            venueCount: isSet(object.venueCount) ? globalThis.Number(object.venueCount) : 0,
+            globalRankingPositionPercentage: isSet(object.globalRankingPositionPercentage)
+                ? globalThis.String(object.globalRankingPositionPercentage)
+                : undefined,
+            globalRankingPosition: isSet(object.globalRankingPosition)
+                ? globalThis.Number(object.globalRankingPosition)
+                : undefined,
+            programmeCountByLevel: isObject(object.programmeCountByLevel)
+                ? Object.entries(object.programmeCountByLevel).reduce((acc, [key, value]) => {
+                    acc[key] = Number(value);
+                    return acc;
+                }, {})
+                : {},
+            scholarshipCountByLevel: isObject(object.scholarshipCountByLevel)
+                ? Object.entries(object.scholarshipCountByLevel).reduce((acc, [key, value]) => {
+                    acc[key] = Number(value);
+                    return acc;
+                }, {})
+                : {},
+            isPublicFunding: isSet(object.isPublicFunding) ? globalThis.Boolean(object.isPublicFunding) : false,
+            isNonProfitFunding: isSet(object.isNonProfitFunding) ? globalThis.Boolean(object.isNonProfitFunding) : false,
+            isForProfitFunding: isSet(object.isForProfitFunding) ? globalThis.Boolean(object.isForProfitFunding) : false,
+            reviewRating: isSet(object.reviewRating) ? ReviewRating.fromJSON(object.reviewRating) : undefined,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.id !== 0) {
+            obj.id = Math.round(message.id);
+        }
+        if (message.name !== "") {
+            obj.name = message.name;
+        }
+        if (message.summary !== undefined) {
+            obj.summary = message.summary;
+        }
+        if (message.relativeUrlPath !== "") {
+            obj.relativeUrlPath = message.relativeUrlPath;
+        }
+        if (message.logoUrl !== undefined) {
+            obj.logoUrl = message.logoUrl;
+        }
+        if (message.locations?.length) {
+            obj.locations = message.locations.map((e) => Location.toJSON(e));
+        }
+        if (message.hasAttendanceOnline !== false) {
+            obj.hasAttendanceOnline = message.hasAttendanceOnline;
+        }
+        if (message.hasAttendanceOnCampus !== false) {
+            obj.hasAttendanceOnCampus = message.hasAttendanceOnCampus;
+        }
+        if (message.hasAttendanceBlended !== false) {
+            obj.hasAttendanceBlended = message.hasAttendanceBlended;
+        }
+        if (message.venueCount !== 0) {
+            obj.venueCount = Math.round(message.venueCount);
+        }
+        if (message.globalRankingPositionPercentage !== undefined) {
+            obj.globalRankingPositionPercentage = message.globalRankingPositionPercentage;
+        }
+        if (message.globalRankingPosition !== undefined) {
+            obj.globalRankingPosition = Math.round(message.globalRankingPosition);
+        }
+        if (message.programmeCountByLevel) {
+            const entries = Object.entries(message.programmeCountByLevel);
+            if (entries.length > 0) {
+                obj.programmeCountByLevel = {};
+                entries.forEach(([k, v]) => {
+                    obj.programmeCountByLevel[k] = Math.round(v);
+                });
+            }
+        }
+        if (message.scholarshipCountByLevel) {
+            const entries = Object.entries(message.scholarshipCountByLevel);
+            if (entries.length > 0) {
+                obj.scholarshipCountByLevel = {};
+                entries.forEach(([k, v]) => {
+                    obj.scholarshipCountByLevel[k] = Math.round(v);
+                });
+            }
+        }
+        if (message.isPublicFunding !== false) {
+            obj.isPublicFunding = message.isPublicFunding;
+        }
+        if (message.isNonProfitFunding !== false) {
+            obj.isNonProfitFunding = message.isNonProfitFunding;
+        }
+        if (message.isForProfitFunding !== false) {
+            obj.isForProfitFunding = message.isForProfitFunding;
+        }
+        if (message.reviewRating !== undefined) {
+            obj.reviewRating = ReviewRating.toJSON(message.reviewRating);
+        }
+        return obj;
+    },
+};
+export const OrganisationCard_ProgrammeCountByLevelEntry = {
+    fromJSON(object) {
+        return {
+            key: isSet(object.key) ? globalThis.String(object.key) : "",
+            value: isSet(object.value) ? globalThis.Number(object.value) : 0,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.key !== "") {
+            obj.key = message.key;
+        }
+        if (message.value !== 0) {
+            obj.value = Math.round(message.value);
+        }
+        return obj;
+    },
+};
+export const OrganisationCard_ScholarshipCountByLevelEntry = {
+    fromJSON(object) {
+        return {
+            key: isSet(object.key) ? globalThis.String(object.key) : "",
+            value: isSet(object.value) ? globalThis.Number(object.value) : 0,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.key !== "") {
+            obj.key = message.key;
+        }
+        if (message.value !== 0) {
+            obj.value = Math.round(message.value);
+        }
+        return obj;
+    },
+};
+function isObject(value) {
+    return typeof value === "object" && value !== null;
+}
+function isSet(value) {
+    return value !== null && value !== undefined;
+}

package/protobuf/index.d.ts

@@ -44,4 +44,5 @@ export * from "./TrackedLink.js";
 export * from "./Tracking.js";
 export * from "./TuitionFee.js";
 export * from "./Unibuddy.js";
+export * from "./Organisation/OrganisationCard.js";
 export * from "./google/protobuf/timestamp.js";

package/protobuf/index.js

@@ -44,4 +44,5 @@ export * from "./TrackedLink.js";
 export * from "./Tracking.js";
 export * from "./TuitionFee.js";
 export * from "./Unibuddy.js";
+export * from "./Organisation/OrganisationCard.js";
 export * from "./google/protobuf/timestamp.js";

package/src/clients/index.d.ts

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

package/src/clients/index.js

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

package/src/clients/organisation-card-v2-client.d.ts

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

package/src/clients/organisation-card-v2-client.js

@@ -0,0 +1,16 @@
+import { OrganisationCard } from "../../protobuf/index.js";
+import { ProtobufClient } from "./protobuf-client.js";
+export class OrganisationCardV2Client extends ProtobufClient {
+    constructModel(data) {
+        return OrganisationCard.fromJSON(data);
+    }
+    getModelName() {
+        return 'organisation-card-v2';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}

package/src/models/copilot-programme/i-deadline.d.ts

@@ -0,0 +1,20 @@
+export interface IDeadline {
+    /**
+     * Get the date this deadline expires on.
+     *
+     * @return Date
+     */
+    getDate(): Date;
+    /**
+     * Get the deadline type (e.g. general, national, eea, etc).
+     *
+     * @return string
+     */
+    getType(): string;
+    /**
+     * True if the deadline has passed (e.g. you can't apply anymore).
+     *
+     * @return boolean
+     */
+    isPassed(): boolean;
+}

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

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

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

@@ -0,0 +1,51 @@
+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/copilot-programme/i-english-requirements.js

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

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

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

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

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

package/src/models/copilot-programme/i-geo-targeting-configuration.d.ts

@@ -0,0 +1,38 @@
+export interface IGeoTargetingConfiguration {
+    /**
+     * Bit set 1 of targeted country ID information.
+     *
+     * @return number
+     */
+    getBit1(): number;
+    /**
+     * Bit set 2 of targeted country ID information.
+     *
+     * @return number
+     */
+    getBit2(): number;
+    /**
+     * Bit set 3 of targeted country ID information.
+     *
+     * @return number
+     */
+    getBit3(): number;
+    /**
+     * Bit set 4 of targeted country ID information.
+     *
+     * @return number
+     */
+    getBit4(): number;
+    /**
+     * Bit set 5 of targeted country ID information.
+     *
+     * @return number
+     */
+    getBit5(): number;
+    /**
+     * List of all configured country IDs.
+     *
+     * @return number[]
+     */
+    getTargetedCountries(): number[];
+}

package/src/models/copilot-programme/i-geo-targeting-configuration.js

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

package/src/models/copilot-programme/i-geo-targeting-values.d.ts

@@ -0,0 +1,30 @@
+import { IGeoTargetingConfiguration } from "../../../index.js";
+export interface IGeoTargetingValues {
+    /**
+     * Geo-targeting configuration for "light premium" listing.
+     *
+     * @return IGeoTargetingConfiguration
+     */
+    getLightPremium(): IGeoTargetingConfiguration;
+    canShowLightPremium(): boolean;
+    /**
+     * Geo-targeting configuration for "premium" listing.
+     *
+     * @return IGeoTargetingConfiguration
+     */
+    getPremium(): IGeoTargetingConfiguration;
+    canShowPremium(): boolean;
+    /**
+     * Geo-targeting configuration for "super premium" listing.
+     *
+     * @return IGeoTargetingConfiguration
+     */
+    getSuperPremium(): IGeoTargetingConfiguration;
+    canShowSuperPremium(): boolean;
+    /**
+     * Programme has active geo-targeting settings.
+     *
+     * @return boolean
+     */
+    isGeoTargeted(): boolean;
+}

package/src/models/copilot-programme/i-geo-targeting-values.js

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

package/src/models/copilot-programme/i-internal-link.d.ts

@@ -0,0 +1,28 @@
+export interface IInternalLink {
+    /**
+     * Get an optional text describing the link (typically <a>-tags contents).
+     *
+     * @return string
+     * @throws PropertyNotAvailableException
+     */
+    getDescription(): string;
+    canShowDescription(): boolean;
+    /**
+     * Returns on which portal a this link should link towards.
+     *
+     * @return string
+     */
+    getPortalType(): string;
+    /**
+     * Get the url to refer to.
+     *
+     * Note that the url provided is always a relative URL. A base URL is needed
+     * to make it a full valid path.
+     * The only exception is when an external link is provided (meaning, outside
+     * of StudyPortals-maintained domains). In this case a full url will be
+     * provided.
+     *
+     * @return string
+     */
+    getUrl(): string;
+}

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

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

package/src/models/copilot-programme/i-link.d.ts

@@ -0,0 +1,22 @@
+export interface ILink {
+    /**
+     * Get an optional text describing the link (typically <a>-tags contents).
+     *
+     * @return string
+     * @throws PropertyNotAvailableException
+     */
+    getDescription(): string;
+    canShowDescription(): boolean;
+    /**
+     * Get the url to refer to.
+     *
+     * Note that the url provided is always a relative URL. A base URL is needed
+     * to make it a full valid path.
+     * The only exception is when an external link is provided (meaning, outside
+     * of StudyPortals-maintained domains). In this case a full url will be
+     * provided.
+     *
+     * @return string
+     */
+    getUrl(): string;
+}

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

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

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

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

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

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

package/src/models/copilot-programme/i-start-date.d.ts

@@ -0,0 +1,33 @@
+import { IDeadline } from "../../../index.js";
+export interface IStartDate {
+    /**
+     * Get the date the programme starts on.
+     *
+     * @return Date
+     */
+    getDate(): Date;
+    /**
+     * Get a list of deadlines that apply to this start date.
+     *
+     * Note: In case of extendable start dates, all information in the
+     * Deadline objects has already been extended to the first available start
+     * date.
+     *
+     * @return IDeadline[]
+     * @throws PropertyNotAvailableException
+     */
+    getDeadlines(): IDeadline[];
+    canShowDeadlines(): boolean;
+    /**
+     * True if you can apply at any time for this programme (rolling admission)
+     *
+     * @return boolean
+     */
+    isApplyingAnytime(): boolean;
+    /**
+     * True if the start date has passed (you can't start at this date anymore).
+     *
+     * @return boolean
+     */
+    isPassed(): boolean;
+}

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

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

package/src/models/copilot-programme/i-timing.d.ts

@@ -0,0 +1,45 @@
+import { IDeadline, IStartDate } from "../../../index.js";
+export interface ITiming {
+    /**
+     * Get the IDeadline applicable for this type and programme.
+     *
+     * Note: In case of extendable start dates, all information in the
+     * Deadline object has already been extended to the first available start
+     * date.
+     *
+     * @return IDeadline
+     * @throws PropertyNotAvailableException
+     */
+    getDeadline(): IDeadline;
+    canShowDeadline(): boolean;
+    /**
+     * Get the IStartDate applicable for this type and programme.
+     *
+     * Note: In case of extendable start dates, all information in the
+     * StartDate objects has already been extended to the first available start
+     * date.
+     *
+     * @return IStartDate
+     * @throws PropertyNotAvailableException
+     */
+    getStartDate(): IStartDate;
+    canShowStartDate(): boolean;
+    /**
+     * Type of user the timing is applicable to (e.g. general, eea, national).
+     *
+     * @return string
+     */
+    getType(): string;
+    /**
+     * True if the programme allows to apply at any time (rolling application).
+     *
+     * @return boolean
+     */
+    isApplyingAnytime(): boolean;
+    /**
+     * True if the programme can start at any time (rolling admission).
+     *
+     * @return boolean
+     */
+    isStartingAnytime(): boolean;
+}

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

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

package/src/models/copilot-programme/i-tuition-values.d.ts

@@ -0,0 +1,50 @@
+export interface ITuitionValues {
+    /**
+     * Tuition (converted to per year if possible) for EEA students.
+     *
+     * @return number
+     */
+    getTuitionEea(): number;
+    canShowTuitionEea(): boolean;
+    /**
+     * Tuition currency.
+     *
+     * @return number
+     */
+    getTuitionEeaCurrency(): number;
+    canShowTuitionEeaCurrency(): boolean;
+    /**
+     * Tuition (converted to per year if possible) for international students.
+     *
+     * @return number
+     */
+    getTuitionInternational(): number;
+    canShowTuitionInternational(): boolean;
+    /**
+     * Tuition currency.
+     *
+     * @return number
+     */
+    getTuitionInternationalCurrency(): number;
+    canShowTuitionInternationalCurrency(): boolean;
+    /**
+     * Tuition (converted to per year if possible) for national students.
+     *
+     * @return number
+     */
+    getTuitionNational(): number;
+    canShowTuitionNational(): boolean;
+    /**
+     * Tuition currency.
+     *
+     * @return number
+     */
+    getTuitionNationalCurrency(): number;
+    canShowTuitionNationalCurrency(): boolean;
+    /**
+     * Unit all tuition fees are provided in.
+     *
+     * @return number
+     */
+    getTuitionUnitType(): number;
+}