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

package/package.json

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

package/protobuf/PartnerApi/PartnerApiOrganisation.d.ts

@@ -0,0 +1,18 @@
+import { File } from "../File.js";
+import { Location } from "../Location.js";
+import { SocialLink } from "../SocialLink.js";
+export interface PartnerApiOrganisation {
+    id: number;
+    name: string;
+    logo?: File | undefined;
+    location?: string | undefined;
+    about?: string | undefined;
+    locations: Location[];
+    links: SocialLink[];
+}
+export declare const PartnerApiOrganisation: MessageFns<PartnerApiOrganisation>;
+interface MessageFns<T> {
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+}
+export {};

package/protobuf/PartnerApi/PartnerApiOrganisation.js

@@ -0,0 +1,54 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.11.8
+//   protoc               v3.21.12
+// source: PartnerApi/PartnerApiOrganisation.proto
+/* eslint-disable */
+import { File } from "../File.js";
+import { Location } from "../Location.js";
+import { SocialLink } from "../SocialLink.js";
+export const PartnerApiOrganisation = {
+    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,
+            about: isSet(object.about) ? globalThis.String(object.about) : undefined,
+            locations: globalThis.Array.isArray(object?.locations)
+                ? object.locations.map((e) => Location.fromJSON(e))
+                : [],
+            links: globalThis.Array.isArray(object?.links)
+                ? object.links.map((e) => SocialLink.fromJSON(e))
+                : [],
+        };
+    },
+    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.about !== undefined) {
+            obj.about = message.about;
+        }
+        if (message.locations?.length) {
+            obj.locations = message.locations.map((e) => Location.toJSON(e));
+        }
+        if (message.links?.length) {
+            obj.links = message.links.map((e) => SocialLink.toJSON(e));
+        }
+        return obj;
+    },
+};
+function isSet(value) {
+    return value !== null && value !== undefined;
+}

package/protobuf/PartnerApi/PartnerApiProgramme.d.ts

@@ -0,0 +1,21 @@
+import { Location } from "../Location.js";
+import { Logo } from "../Logo.js";
+import { TuitionFee as TuitionFeeDetails } from "../TuitionFee.js";
+import { Timing } from "../Timing.js";
+export interface PartnerApiProgramme {
+    id: number;
+    title: string;
+    pagePortalType: string;
+    degreeFormatted: string;
+    summary?: string | undefined;
+    logo?: Logo | undefined;
+    tuitionFeeDetails?: TuitionFeeDetails | undefined;
+    locations: Location[];
+    timings: Timing[];
+}
+export declare const PartnerApiProgramme: MessageFns<PartnerApiProgramme>;
+interface MessageFns<T> {
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+}
+export {};

package/protobuf/PartnerApi/{Programme.js → PartnerApiProgramme.js}

@@ -2,24 +2,28 @@
 // versions:
 //   protoc-gen-ts_proto  v2.11.8
 //   protoc               v3.21.12
-// source: PartnerApi/Programme.proto
+// source: PartnerApi/PartnerApiProgramme.proto
 /* eslint-disable */
+import { Location } from "../Location.js";
 import { Logo } from "../Logo.js";
-import { Description } from "../Description.js";
-import { StartDate } from "../StartDate.js";
-import { TuitionFee } from "../TuitionFee.js";
-export const Programme = {
+import { TuitionFee as TuitionFeeDetails } from "../TuitionFee.js";
+import { Timing } from "../Timing.js";
+export const PartnerApiProgramme = {
     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,
+            tuitionFeeDetails: isSet(object.tuitionFeeDetails)
+                ? TuitionFeeDetails.fromJSON(object.tuitionFeeDetails)
+                : undefined,
+            locations: globalThis.Array.isArray(object?.locations)
+                ? object.locations.map((e) => Location.fromJSON(e))
+                : [],
+            timings: globalThis.Array.isArray(object?.timings) ? object.timings.map((e) => Timing.fromJSON(e)) : [],
         };
     },
     toJSON(message) {
@@ -36,20 +40,20 @@ export const Programme = {
         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.tuitionFeeDetails !== undefined) {
+            obj.tuitionFeeDetails = TuitionFeeDetails.toJSON(message.tuitionFeeDetails);
+        }
+        if (message.locations?.length) {
+            obj.locations = message.locations.map((e) => Location.toJSON(e));
         }
-        if (message.startDates !== undefined) {
-            obj.startDates = StartDate.toJSON(message.startDates);
+        if (message.timings?.length) {
+            obj.timings = message.timings.map((e) => Timing.toJSON(e));
         }
         return obj;
     },

package/protobuf/PartnerApi/PartnerApiScholarship.d.ts

@@ -0,0 +1,42 @@
+import { Link } from "../Link.js";
+import { Location } from "../Location.js";
+export interface PartnerApiScholarship {
+    id: string;
+    title: string;
+    providerName?: string | undefined;
+    providerLocation?: string | undefined;
+    scholarshipDetailsLink?: Link | undefined;
+    funding?: PartnerApiFunding | undefined;
+    eligibility?: PartnerApiEligibility | undefined;
+    about?: string | undefined;
+    providerLogo?: string | undefined;
+    sourceUrl?: string | undefined;
+    organisation?: PartnerApiScholarshipOrganisation | undefined;
+}
+export interface PartnerApiFunding {
+    kind: string;
+    hasGrantAmount: boolean;
+    grantAmount?: number | undefined;
+    grantCurrencyIso?: string | undefined;
+    description?: string | undefined;
+}
+export interface PartnerApiEligibility {
+    nationality?: string | undefined;
+    studyLevel?: string | undefined;
+    scholarshipType?: string | undefined;
+    description?: string | undefined;
+}
+export interface PartnerApiScholarshipOrganisation {
+    id: number;
+    name: string;
+    locations: Location[];
+}
+export declare const PartnerApiScholarship: MessageFns<PartnerApiScholarship>;
+export declare const PartnerApiFunding: MessageFns<PartnerApiFunding>;
+export declare const PartnerApiEligibility: MessageFns<PartnerApiEligibility>;
+export declare const PartnerApiScholarshipOrganisation: MessageFns<PartnerApiScholarshipOrganisation>;
+interface MessageFns<T> {
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+}
+export {};

package/protobuf/PartnerApi/{Scholarship.js → PartnerApiScholarship.js}

@@ -2,24 +2,28 @@
 // versions:
 //   protoc-gen-ts_proto  v2.11.8
 //   protoc               v3.21.12
-// source: PartnerApi/Scholarship.proto
+// source: PartnerApi/PartnerApiScholarship.proto
 /* eslint-disable */
 import { Link } from "../Link.js";
-export const Scholarship = {
+import { Location } from "../Location.js";
+export const PartnerApiScholarship = {
     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,
+            funding: isSet(object.funding) ? PartnerApiFunding.fromJSON(object.funding) : undefined,
+            eligibility: isSet(object.eligibility) ? PartnerApiEligibility.fromJSON(object.eligibility) : undefined,
             about: isSet(object.about) ? globalThis.String(object.about) : undefined,
             providerLogo: isSet(object.providerLogo) ? globalThis.String(object.providerLogo) : undefined,
+            sourceUrl: isSet(object.sourceUrl) ? globalThis.String(object.sourceUrl) : undefined,
+            organisation: isSet(object.organisation)
+                ? PartnerApiScholarshipOrganisation.fromJSON(object.organisation)
+                : undefined,
         };
     },
     toJSON(message) {
@@ -36,17 +40,14 @@ export const Scholarship = {
         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);
+            obj.funding = PartnerApiFunding.toJSON(message.funding);
         }
         if (message.eligibility !== undefined) {
-            obj.eligibility = Eligibility.toJSON(message.eligibility);
+            obj.eligibility = PartnerApiEligibility.toJSON(message.eligibility);
         }
         if (message.about !== undefined) {
             obj.about = message.about;
@@ -54,10 +55,16 @@ export const Scholarship = {
         if (message.providerLogo !== undefined) {
             obj.providerLogo = message.providerLogo;
         }
+        if (message.sourceUrl !== undefined) {
+            obj.sourceUrl = message.sourceUrl;
+        }
+        if (message.organisation !== undefined) {
+            obj.organisation = PartnerApiScholarshipOrganisation.toJSON(message.organisation);
+        }
         return obj;
     },
 };
-export const Funding = {
+export const PartnerApiFunding = {
     fromJSON(object) {
         return {
             kind: isSet(object.kind) ? globalThis.String(object.kind) : "",
@@ -87,7 +94,7 @@ export const Funding = {
         return obj;
     },
 };
-export const Eligibility = {
+export const PartnerApiEligibility = {
     fromJSON(object) {
         return {
             nationality: isSet(object.nationality) ? globalThis.String(object.nationality) : undefined,
@@ -113,6 +120,30 @@ export const Eligibility = {
         return obj;
     },
 };
+export const PartnerApiScholarshipOrganisation = {
+    fromJSON(object) {
+        return {
+            id: isSet(object.id) ? globalThis.Number(object.id) : 0,
+            name: isSet(object.name) ? globalThis.String(object.name) : "",
+            locations: globalThis.Array.isArray(object?.locations)
+                ? object.locations.map((e) => Location.fromJSON(e))
+                : [],
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.id !== 0) {
+            obj.id = Math.round(message.id);
+        }
+        if (message.name !== "") {
+            obj.name = message.name;
+        }
+        if (message.locations?.length) {
+            obj.locations = message.locations.map((e) => Location.toJSON(e));
+        }
+        return obj;
+    },
+};
 function isSet(value) {
     return value !== null && value !== undefined;
 }

package/protobuf/PartnerApi/Organisation.d.ts

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

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

@@ -1,21 +0,0 @@
-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/Scholarship.d.ts

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