@studyportals/domain-client 10.4.0 → 10.5.0

package/package.json

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

package/protobuf/Scholarship/ScholarshipCard.d.ts

@@ -0,0 +1,46 @@
+import { Location } from "../Location.js";
+import { ReviewRating } from "../ReviewRating.js";
+export interface ScholarshipCard {
+    id: number;
+    title: string;
+    virtualName: string;
+    relativeUrlPath: string;
+    description: string;
+    providerId?: string | undefined;
+    providerName: string;
+    isUniversityProvider: boolean;
+    providerLogoUrl?: string | undefined;
+    providerLocationText?: string | undefined;
+    /** only set when isUniversityProvider */
+    providerOrganisation?: ScholarshipProviderOrganisation | undefined;
+    benefitText?: string | undefined;
+    deadlineText: string;
+    isDeadlineNotSpecified: boolean;
+    destinationCountryRestrictionText: string;
+    applicationBasisText?: string | undefined;
+    grantCurrencyIso?: string | undefined;
+    grantAmount?: number | undefined;
+    grantDescription?: string | undefined;
+    isApplicableToAllDisciplines: boolean;
+    disciplineIds: number[];
+    isApplicableToAllOriginCountries: boolean;
+    originCountryIsoCodes: string[];
+    isApplicableToAllDestinationCountries: boolean;
+    destinationCountryIsoCodes: string[];
+}
+export interface ScholarshipProviderOrganisation {
+    id: number;
+    name: string;
+    relativeUrlPath: string;
+    locations: Location[];
+    reviewRating?: ReviewRating | undefined;
+    globalRankingPosition?: number | undefined;
+    globalRankingPositionPercentage?: string | undefined;
+}
+export declare const ScholarshipCard: MessageFns<ScholarshipCard>;
+export declare const ScholarshipProviderOrganisation: MessageFns<ScholarshipProviderOrganisation>;
+interface MessageFns<T> {
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+}
+export {};

package/protobuf/Scholarship/ScholarshipCard.js

@@ -0,0 +1,189 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.7.7
+//   protoc               v6.33.2
+// source: Scholarship/ScholarshipCard.proto
+/* eslint-disable */
+import { Location } from "../Location.js";
+import { ReviewRating } from "../ReviewRating.js";
+export const ScholarshipCard = {
+    fromJSON(object) {
+        return {
+            id: isSet(object.id) ? globalThis.Number(object.id) : 0,
+            title: isSet(object.title) ? globalThis.String(object.title) : "",
+            virtualName: isSet(object.virtualName) ? globalThis.String(object.virtualName) : "",
+            relativeUrlPath: isSet(object.relativeUrlPath) ? globalThis.String(object.relativeUrlPath) : "",
+            description: isSet(object.description) ? globalThis.String(object.description) : "",
+            providerId: isSet(object.providerId) ? globalThis.String(object.providerId) : undefined,
+            providerName: isSet(object.providerName) ? globalThis.String(object.providerName) : "",
+            isUniversityProvider: isSet(object.isUniversityProvider)
+                ? globalThis.Boolean(object.isUniversityProvider)
+                : false,
+            providerLogoUrl: isSet(object.providerLogoUrl) ? globalThis.String(object.providerLogoUrl) : undefined,
+            providerLocationText: isSet(object.providerLocationText)
+                ? globalThis.String(object.providerLocationText)
+                : undefined,
+            providerOrganisation: isSet(object.providerOrganisation)
+                ? ScholarshipProviderOrganisation.fromJSON(object.providerOrganisation)
+                : undefined,
+            benefitText: isSet(object.benefitText) ? globalThis.String(object.benefitText) : undefined,
+            deadlineText: isSet(object.deadlineText) ? globalThis.String(object.deadlineText) : "",
+            isDeadlineNotSpecified: isSet(object.isDeadlineNotSpecified)
+                ? globalThis.Boolean(object.isDeadlineNotSpecified)
+                : false,
+            destinationCountryRestrictionText: isSet(object.destinationCountryRestrictionText)
+                ? globalThis.String(object.destinationCountryRestrictionText)
+                : "",
+            applicationBasisText: isSet(object.applicationBasisText)
+                ? globalThis.String(object.applicationBasisText)
+                : undefined,
+            grantCurrencyIso: isSet(object.grantCurrencyIso) ? globalThis.String(object.grantCurrencyIso) : undefined,
+            grantAmount: isSet(object.grantAmount) ? globalThis.Number(object.grantAmount) : undefined,
+            grantDescription: isSet(object.grantDescription) ? globalThis.String(object.grantDescription) : undefined,
+            isApplicableToAllDisciplines: isSet(object.isApplicableToAllDisciplines)
+                ? globalThis.Boolean(object.isApplicableToAllDisciplines)
+                : false,
+            disciplineIds: globalThis.Array.isArray(object?.disciplineIds)
+                ? object.disciplineIds.map((e) => globalThis.Number(e))
+                : [],
+            isApplicableToAllOriginCountries: isSet(object.isApplicableToAllOriginCountries)
+                ? globalThis.Boolean(object.isApplicableToAllOriginCountries)
+                : false,
+            originCountryIsoCodes: globalThis.Array.isArray(object?.originCountryIsoCodes)
+                ? object.originCountryIsoCodes.map((e) => globalThis.String(e))
+                : [],
+            isApplicableToAllDestinationCountries: isSet(object.isApplicableToAllDestinationCountries)
+                ? globalThis.Boolean(object.isApplicableToAllDestinationCountries)
+                : false,
+            destinationCountryIsoCodes: globalThis.Array.isArray(object?.destinationCountryIsoCodes)
+                ? object.destinationCountryIsoCodes.map((e) => globalThis.String(e))
+                : [],
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.id !== 0) {
+            obj.id = Math.round(message.id);
+        }
+        if (message.title !== "") {
+            obj.title = message.title;
+        }
+        if (message.virtualName !== "") {
+            obj.virtualName = message.virtualName;
+        }
+        if (message.relativeUrlPath !== "") {
+            obj.relativeUrlPath = message.relativeUrlPath;
+        }
+        if (message.description !== "") {
+            obj.description = message.description;
+        }
+        if (message.providerId !== undefined) {
+            obj.providerId = message.providerId;
+        }
+        if (message.providerName !== "") {
+            obj.providerName = message.providerName;
+        }
+        if (message.isUniversityProvider !== false) {
+            obj.isUniversityProvider = message.isUniversityProvider;
+        }
+        if (message.providerLogoUrl !== undefined) {
+            obj.providerLogoUrl = message.providerLogoUrl;
+        }
+        if (message.providerLocationText !== undefined) {
+            obj.providerLocationText = message.providerLocationText;
+        }
+        if (message.providerOrganisation !== undefined) {
+            obj.providerOrganisation = ScholarshipProviderOrganisation.toJSON(message.providerOrganisation);
+        }
+        if (message.benefitText !== undefined) {
+            obj.benefitText = message.benefitText;
+        }
+        if (message.deadlineText !== "") {
+            obj.deadlineText = message.deadlineText;
+        }
+        if (message.isDeadlineNotSpecified !== false) {
+            obj.isDeadlineNotSpecified = message.isDeadlineNotSpecified;
+        }
+        if (message.destinationCountryRestrictionText !== "") {
+            obj.destinationCountryRestrictionText = message.destinationCountryRestrictionText;
+        }
+        if (message.applicationBasisText !== undefined) {
+            obj.applicationBasisText = message.applicationBasisText;
+        }
+        if (message.grantCurrencyIso !== undefined) {
+            obj.grantCurrencyIso = message.grantCurrencyIso;
+        }
+        if (message.grantAmount !== undefined) {
+            obj.grantAmount = message.grantAmount;
+        }
+        if (message.grantDescription !== undefined) {
+            obj.grantDescription = message.grantDescription;
+        }
+        if (message.isApplicableToAllDisciplines !== false) {
+            obj.isApplicableToAllDisciplines = message.isApplicableToAllDisciplines;
+        }
+        if (message.disciplineIds?.length) {
+            obj.disciplineIds = message.disciplineIds.map((e) => Math.round(e));
+        }
+        if (message.isApplicableToAllOriginCountries !== false) {
+            obj.isApplicableToAllOriginCountries = message.isApplicableToAllOriginCountries;
+        }
+        if (message.originCountryIsoCodes?.length) {
+            obj.originCountryIsoCodes = message.originCountryIsoCodes;
+        }
+        if (message.isApplicableToAllDestinationCountries !== false) {
+            obj.isApplicableToAllDestinationCountries = message.isApplicableToAllDestinationCountries;
+        }
+        if (message.destinationCountryIsoCodes?.length) {
+            obj.destinationCountryIsoCodes = message.destinationCountryIsoCodes;
+        }
+        return obj;
+    },
+};
+export const ScholarshipProviderOrganisation = {
+    fromJSON(object) {
+        return {
+            id: isSet(object.id) ? globalThis.Number(object.id) : 0,
+            name: isSet(object.name) ? globalThis.String(object.name) : "",
+            relativeUrlPath: isSet(object.relativeUrlPath) ? globalThis.String(object.relativeUrlPath) : "",
+            locations: globalThis.Array.isArray(object?.locations)
+                ? object.locations.map((e) => Location.fromJSON(e))
+                : [],
+            reviewRating: isSet(object.reviewRating) ? ReviewRating.fromJSON(object.reviewRating) : undefined,
+            globalRankingPosition: isSet(object.globalRankingPosition)
+                ? globalThis.Number(object.globalRankingPosition)
+                : undefined,
+            globalRankingPositionPercentage: isSet(object.globalRankingPositionPercentage)
+                ? globalThis.String(object.globalRankingPositionPercentage)
+                : undefined,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.id !== 0) {
+            obj.id = Math.round(message.id);
+        }
+        if (message.name !== "") {
+            obj.name = message.name;
+        }
+        if (message.relativeUrlPath !== "") {
+            obj.relativeUrlPath = message.relativeUrlPath;
+        }
+        if (message.locations?.length) {
+            obj.locations = message.locations.map((e) => Location.toJSON(e));
+        }
+        if (message.reviewRating !== undefined) {
+            obj.reviewRating = ReviewRating.toJSON(message.reviewRating);
+        }
+        if (message.globalRankingPosition !== undefined) {
+            obj.globalRankingPosition = Math.round(message.globalRankingPosition);
+        }
+        if (message.globalRankingPositionPercentage !== undefined) {
+            obj.globalRankingPositionPercentage = message.globalRankingPositionPercentage;
+        }
+        return obj;
+    },
+};
+function isSet(value) {
+    return value !== null && value !== undefined;
+}

package/protobuf/index.d.ts

@@ -45,4 +45,9 @@ export * from "./Tracking.js";
 export * from "./TuitionFee.js";
 export * from "./Unibuddy.js";
 export * from "./Organisation/OrganisationCard.js";
+export * from "./PartnerApi/PartnerApiOrganisation.js";
+export * from "./PartnerApi/PartnerApiProgramme.js";
+export * from "./PartnerApi/PartnerApiScholarship.js";
+export * from "./Scholarship/MiniScholarshipCard.js";
+export * from "./Scholarship/ScholarshipCard.js";
 export * from "./google/protobuf/timestamp.js";

package/protobuf/index.js

@@ -45,4 +45,9 @@ export * from "./Tracking.js";
 export * from "./TuitionFee.js";
 export * from "./Unibuddy.js";
 export * from "./Organisation/OrganisationCard.js";
+export * from "./PartnerApi/PartnerApiOrganisation.js";
+export * from "./PartnerApi/PartnerApiProgramme.js";
+export * from "./PartnerApi/PartnerApiScholarship.js";
+export * from "./Scholarship/MiniScholarshipCard.js";
+export * from "./Scholarship/ScholarshipCard.js";
 export * from "./google/protobuf/timestamp.js";

package/src/clients/index.d.ts

@@ -4,9 +4,10 @@
 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";
-export * from "./public-mini-programme-card-client.js";
 export * from "./partner-api-organisation-client.js";
 export * from "./partner-api-programme-client.js";
 export * from "./partner-api-scholarship-client.js";
+export * from "./programme-card-v2-client.js";
+export * from "./protobuf-client.js";
+export * from "./public-mini-programme-card-client.js";
+export * from "./scholarship-card-v3-client.js";

package/src/clients/index.js

@@ -4,9 +4,10 @@
 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";
-export * from "./public-mini-programme-card-client.js";
 export * from "./partner-api-organisation-client.js";
 export * from "./partner-api-programme-client.js";
 export * from "./partner-api-scholarship-client.js";
+export * from "./programme-card-v2-client.js";
+export * from "./protobuf-client.js";
+export * from "./public-mini-programme-card-client.js";
+export * from "./scholarship-card-v3-client.js";

package/src/clients/scholarship-card-v3-client.d.ts

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

package/src/clients/scholarship-card-v3-client.js

@@ -0,0 +1,16 @@
+import { ScholarshipCard } from "../../protobuf/Scholarship/ScholarshipCard.js";
+import { ProtobufClient } from "./protobuf-client.js";
+export class ScholarshipCardV3Client extends ProtobufClient {
+    constructModel(data) {
+        return ScholarshipCard.fromJSON(data);
+    }
+    getModelName() {
+        return 'scholarship-card-v3';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}