@studyportals/domain-client 8.4.0 → 8.5.1-beta.11

package/package.json

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

package/protobuf/Organisation/OrganisationCard.d.ts

@@ -23,6 +23,7 @@ export interface OrganisationCard {
     isNonProfitFunding: boolean;
     isForProfitFunding: boolean;
     reviewRating?: ReviewRating | undefined;
+    isPremium: boolean;
 }
 export interface OrganisationCard_ProgrammeCountByLevelEntry {
     key: string;

package/protobuf/Organisation/OrganisationCard.js

@@ -47,6 +47,7 @@ export const OrganisationCard = {
             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,
+            isPremium: isSet(object.isPremium) ? globalThis.Boolean(object.isPremium) : false,
         };
     },
     toJSON(message) {
@@ -117,6 +118,9 @@ export const OrganisationCard = {
         if (message.reviewRating !== undefined) {
             obj.reviewRating = ReviewRating.toJSON(message.reviewRating);
         }
+        if (message.isPremium !== false) {
+            obj.isPremium = message.isPremium;
+        }
         return obj;
     },
 };

package/protobuf/PartnerApi/Organisation.d.ts

@@ -0,0 +1,31 @@
+import { File } from "../File.js";
+import { Link } from "../Link.js";
+export interface Organisation {
+    id: number;
+    name: string;
+    logo?: File | undefined;
+    location?: string | undefined;
+    organisationLink?: Link | undefined;
+    about?: string | undefined;
+    courses?: CourseCount | undefined;
+    locations: OrganisationLocation[];
+    institutionWebsiteLink?: Link | undefined;
+}
+export interface CourseCount {
+    undergraduate: number;
+    postgraduate: number;
+    phd: number;
+}
+export interface OrganisationLocation {
+    name: string;
+    address?: string | undefined;
+    mapLink?: Link | undefined;
+}
+export declare const Organisation: MessageFns<Organisation>;
+export declare const CourseCount: MessageFns<CourseCount>;
+export declare const OrganisationLocation: MessageFns<OrganisationLocation>;
+interface MessageFns<T> {
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+}
+export {};

package/protobuf/PartnerApi/Organisation.js

@@ -0,0 +1,105 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.11.8
+//   protoc               v3.21.12
+// source: PartnerApi/Organisation.proto
+/* eslint-disable */
+import { File } from "../File.js";
+import { Link } from "../Link.js";
+export const Organisation = {
+    fromJSON(object) {
+        return {
+            id: isSet(object.id) ? globalThis.Number(object.id) : 0,
+            name: isSet(object.name) ? globalThis.String(object.name) : "",
+            logo: isSet(object.logo) ? File.fromJSON(object.logo) : undefined,
+            location: isSet(object.location) ? globalThis.String(object.location) : undefined,
+            organisationLink: isSet(object.organisationLink) ? Link.fromJSON(object.organisationLink) : undefined,
+            about: isSet(object.about) ? globalThis.String(object.about) : undefined,
+            courses: isSet(object.courses) ? CourseCount.fromJSON(object.courses) : undefined,
+            locations: globalThis.Array.isArray(object?.locations)
+                ? object.locations.map((e) => OrganisationLocation.fromJSON(e))
+                : [],
+            institutionWebsiteLink: isSet(object.institutionWebsiteLink)
+                ? Link.fromJSON(object.institutionWebsiteLink)
+                : undefined,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.id !== 0) {
+            obj.id = Math.round(message.id);
+        }
+        if (message.name !== "") {
+            obj.name = message.name;
+        }
+        if (message.logo !== undefined) {
+            obj.logo = File.toJSON(message.logo);
+        }
+        if (message.location !== undefined) {
+            obj.location = message.location;
+        }
+        if (message.organisationLink !== undefined) {
+            obj.organisationLink = Link.toJSON(message.organisationLink);
+        }
+        if (message.about !== undefined) {
+            obj.about = message.about;
+        }
+        if (message.courses !== undefined) {
+            obj.courses = CourseCount.toJSON(message.courses);
+        }
+        if (message.locations?.length) {
+            obj.locations = message.locations.map((e) => OrganisationLocation.toJSON(e));
+        }
+        if (message.institutionWebsiteLink !== undefined) {
+            obj.institutionWebsiteLink = Link.toJSON(message.institutionWebsiteLink);
+        }
+        return obj;
+    },
+};
+export const CourseCount = {
+    fromJSON(object) {
+        return {
+            undergraduate: isSet(object.undergraduate) ? globalThis.Number(object.undergraduate) : 0,
+            postgraduate: isSet(object.postgraduate) ? globalThis.Number(object.postgraduate) : 0,
+            phd: isSet(object.phd) ? globalThis.Number(object.phd) : 0,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.undergraduate !== 0) {
+            obj.undergraduate = Math.round(message.undergraduate);
+        }
+        if (message.postgraduate !== 0) {
+            obj.postgraduate = Math.round(message.postgraduate);
+        }
+        if (message.phd !== 0) {
+            obj.phd = Math.round(message.phd);
+        }
+        return obj;
+    },
+};
+export const OrganisationLocation = {
+    fromJSON(object) {
+        return {
+            name: isSet(object.name) ? globalThis.String(object.name) : "",
+            address: isSet(object.address) ? globalThis.String(object.address) : undefined,
+            mapLink: isSet(object.mapLink) ? Link.fromJSON(object.mapLink) : undefined,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.name !== "") {
+            obj.name = message.name;
+        }
+        if (message.address !== undefined) {
+            obj.address = message.address;
+        }
+        if (message.mapLink !== undefined) {
+            obj.mapLink = Link.toJSON(message.mapLink);
+        }
+        return obj;
+    },
+};
+function isSet(value) {
+    return value !== null && value !== undefined;
+}

package/protobuf/PartnerApi/Programme.d.ts

@@ -0,0 +1,21 @@
+import { Logo } from "../Logo.js";
+import { Description } from "../Description.js";
+import { StartDate } from "../StartDate.js";
+import { TuitionFee } from "../TuitionFee.js";
+export interface Programme {
+    id: number;
+    title: string;
+    pagePortalType: string;
+    degreeFormatted: string;
+    description?: Description | undefined;
+    summary?: string | undefined;
+    logo?: Logo | undefined;
+    tuitionFee?: TuitionFee | undefined;
+    startDates?: StartDate | undefined;
+}
+export declare const Programme: MessageFns<Programme>;
+interface MessageFns<T> {
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+}
+export {};

package/protobuf/PartnerApi/Programme.js

@@ -0,0 +1,59 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.11.8
+//   protoc               v3.21.12
+// source: PartnerApi/Programme.proto
+/* eslint-disable */
+import { Logo } from "../Logo.js";
+import { Description } from "../Description.js";
+import { StartDate } from "../StartDate.js";
+import { TuitionFee } from "../TuitionFee.js";
+export const Programme = {
+    fromJSON(object) {
+        return {
+            id: isSet(object.id) ? globalThis.Number(object.id) : 0,
+            title: isSet(object.title) ? globalThis.String(object.title) : "",
+            pagePortalType: isSet(object.pagePortalType) ? globalThis.String(object.pagePortalType) : "",
+            degreeFormatted: isSet(object.degreeFormatted) ? globalThis.String(object.degreeFormatted) : "",
+            description: isSet(object.description) ? Description.fromJSON(object.description) : undefined,
+            summary: isSet(object.summary) ? globalThis.String(object.summary) : undefined,
+            logo: isSet(object.logo) ? Logo.fromJSON(object.logo) : undefined,
+            tuitionFee: isSet(object.tuitionFee) ? TuitionFee.fromJSON(object.tuitionFee) : undefined,
+            startDates: isSet(object.startDates) ? StartDate.fromJSON(object.startDates) : undefined,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.id !== 0) {
+            obj.id = Math.round(message.id);
+        }
+        if (message.title !== "") {
+            obj.title = message.title;
+        }
+        if (message.pagePortalType !== "") {
+            obj.pagePortalType = message.pagePortalType;
+        }
+        if (message.degreeFormatted !== "") {
+            obj.degreeFormatted = message.degreeFormatted;
+        }
+        if (message.description !== undefined) {
+            obj.description = Description.toJSON(message.description);
+        }
+        if (message.summary !== undefined) {
+            obj.summary = message.summary;
+        }
+        if (message.logo !== undefined) {
+            obj.logo = Logo.toJSON(message.logo);
+        }
+        if (message.tuitionFee !== undefined) {
+            obj.tuitionFee = TuitionFee.toJSON(message.tuitionFee);
+        }
+        if (message.startDates !== undefined) {
+            obj.startDates = StartDate.toJSON(message.startDates);
+        }
+        return obj;
+    },
+};
+function isSet(value) {
+    return value !== null && value !== undefined;
+}

package/protobuf/PartnerApi/Scholarship.d.ts

@@ -0,0 +1,34 @@
+import { Link } from "../Link.js";
+export interface Scholarship {
+    id: string;
+    title: string;
+    providerName?: string | undefined;
+    providerLocation?: string | undefined;
+    providerMapLink?: Link | undefined;
+    scholarshipDetailsLink?: Link | undefined;
+    funding?: Funding | undefined;
+    eligibility?: Eligibility | undefined;
+    about?: string | undefined;
+    providerLogo?: string | undefined;
+}
+export interface Funding {
+    kind: string;
+    hasGrantAmount: boolean;
+    grantAmount?: number | undefined;
+    grantCurrencyIso?: string | undefined;
+    description?: string | undefined;
+}
+export interface Eligibility {
+    nationality?: string | undefined;
+    studyLevel?: string | undefined;
+    scholarshipType?: string | undefined;
+    description?: string | undefined;
+}
+export declare const Scholarship: MessageFns<Scholarship>;
+export declare const Funding: MessageFns<Funding>;
+export declare const Eligibility: MessageFns<Eligibility>;
+interface MessageFns<T> {
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+}
+export {};

package/protobuf/PartnerApi/Scholarship.js

@@ -0,0 +1,118 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.11.8
+//   protoc               v3.21.12
+// source: PartnerApi/Scholarship.proto
+/* eslint-disable */
+import { Link } from "../Link.js";
+export const Scholarship = {
+    fromJSON(object) {
+        return {
+            id: isSet(object.id) ? globalThis.String(object.id) : "",
+            title: isSet(object.title) ? globalThis.String(object.title) : "",
+            providerName: isSet(object.providerName) ? globalThis.String(object.providerName) : undefined,
+            providerLocation: isSet(object.providerLocation) ? globalThis.String(object.providerLocation) : undefined,
+            providerMapLink: isSet(object.providerMapLink) ? Link.fromJSON(object.providerMapLink) : undefined,
+            scholarshipDetailsLink: isSet(object.scholarshipDetailsLink)
+                ? Link.fromJSON(object.scholarshipDetailsLink)
+                : undefined,
+            funding: isSet(object.funding) ? Funding.fromJSON(object.funding) : undefined,
+            eligibility: isSet(object.eligibility) ? Eligibility.fromJSON(object.eligibility) : undefined,
+            about: isSet(object.about) ? globalThis.String(object.about) : undefined,
+            providerLogo: isSet(object.providerLogo) ? globalThis.String(object.providerLogo) : undefined,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.id !== "") {
+            obj.id = message.id;
+        }
+        if (message.title !== "") {
+            obj.title = message.title;
+        }
+        if (message.providerName !== undefined) {
+            obj.providerName = message.providerName;
+        }
+        if (message.providerLocation !== undefined) {
+            obj.providerLocation = message.providerLocation;
+        }
+        if (message.providerMapLink !== undefined) {
+            obj.providerMapLink = Link.toJSON(message.providerMapLink);
+        }
+        if (message.scholarshipDetailsLink !== undefined) {
+            obj.scholarshipDetailsLink = Link.toJSON(message.scholarshipDetailsLink);
+        }
+        if (message.funding !== undefined) {
+            obj.funding = Funding.toJSON(message.funding);
+        }
+        if (message.eligibility !== undefined) {
+            obj.eligibility = Eligibility.toJSON(message.eligibility);
+        }
+        if (message.about !== undefined) {
+            obj.about = message.about;
+        }
+        if (message.providerLogo !== undefined) {
+            obj.providerLogo = message.providerLogo;
+        }
+        return obj;
+    },
+};
+export const Funding = {
+    fromJSON(object) {
+        return {
+            kind: isSet(object.kind) ? globalThis.String(object.kind) : "",
+            hasGrantAmount: isSet(object.hasGrantAmount) ? globalThis.Boolean(object.hasGrantAmount) : false,
+            grantAmount: isSet(object.grantAmount) ? globalThis.Number(object.grantAmount) : undefined,
+            grantCurrencyIso: isSet(object.grantCurrencyIso) ? globalThis.String(object.grantCurrencyIso) : undefined,
+            description: isSet(object.description) ? globalThis.String(object.description) : undefined,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.kind !== "") {
+            obj.kind = message.kind;
+        }
+        if (message.hasGrantAmount !== false) {
+            obj.hasGrantAmount = message.hasGrantAmount;
+        }
+        if (message.grantAmount !== undefined) {
+            obj.grantAmount = message.grantAmount;
+        }
+        if (message.grantCurrencyIso !== undefined) {
+            obj.grantCurrencyIso = message.grantCurrencyIso;
+        }
+        if (message.description !== undefined) {
+            obj.description = message.description;
+        }
+        return obj;
+    },
+};
+export const Eligibility = {
+    fromJSON(object) {
+        return {
+            nationality: isSet(object.nationality) ? globalThis.String(object.nationality) : undefined,
+            studyLevel: isSet(object.studyLevel) ? globalThis.String(object.studyLevel) : undefined,
+            scholarshipType: isSet(object.scholarshipType) ? globalThis.String(object.scholarshipType) : undefined,
+            description: isSet(object.description) ? globalThis.String(object.description) : undefined,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.nationality !== undefined) {
+            obj.nationality = message.nationality;
+        }
+        if (message.studyLevel !== undefined) {
+            obj.studyLevel = message.studyLevel;
+        }
+        if (message.scholarshipType !== undefined) {
+            obj.scholarshipType = message.scholarshipType;
+        }
+        if (message.description !== undefined) {
+            obj.description = message.description;
+        }
+        return obj;
+    },
+};
+function isSet(value) {
+    return value !== null && value !== undefined;
+}

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

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

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

package/src/models/copilot-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/copilot-programme/i-english-requirements.js

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

package/src/models/copilot-programme/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/copilot-programme/i-g-p-a-requirement.js

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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