@studyportals/domain-client 8.3.1 → 8.5.0

package/package.json

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

package/protobuf/Organisation/OrganisationCard.d.ts

@@ -0,0 +1,43 @@
+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;
+    isPremium: boolean;
+}
+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,168 @@
+// 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,
+            isPremium: isSet(object.isPremium) ? globalThis.Boolean(object.isPremium) : false,
+        };
+    },
+    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);
+        }
+        if (message.isPremium !== false) {
+            obj.isPremium = message.isPremium;
+        }
+        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;
+    }
+}