@studyportals/domain-client 8.5.1-beta.21 → 8.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@studyportals/domain-client",
-	"version": "8.5.1-beta.21",
+	"version": "8.6.0",
 	"description": "Responsible for fetching data from the Domain API",
 	"type": "module",
 	"main": "index.js",
@@ -37,7 +37,7 @@
 		"prepare-dist": "npm run test  && rm -fR bin && npx tsc && npx tsc-alias -p tsconfig.json --outDir bin -f && cp package.json bin/package.json && rm -fR bin/tests",
 		"publish-beta": "npm version prerelease --preid=beta && npm run prepare-dist && npm publish ./bin --tag beta",
 		"publish-major": "npm version major && npm run prepare-dist && npm publish ./bin",
-		"publish-minor": "npm version minor && npm run prepare-dist && npm publish ./bin",
+		"publish-minor": "npm version minor && npm run prepare-dist && npm publish ./bin --tag v8",
 		"publish-patch": "npm version patch && npm run prepare-dist && npm publish ./bin",
 		"publish-current": "npm run prepare-dist && npm publish ./bin"
 	},

package/src/clients/index.d.ts

@@ -7,6 +7,3 @@ 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-programs-client.js";
-export * from "./partner-api-scholarship-client.js";

package/src/clients/index.js

@@ -7,6 +7,3 @@ 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-programs-client.js";
-export * from "./partner-api-scholarship-client.js";

package/src/models/search-projection/i-search-projection.d.ts

@@ -144,11 +144,11 @@ export interface ISearchProjection {
      */
     getSpecialStudy(): string[];
     /**
-     * List of the start months for the programme.
+     * List of the start dates for the programme.
      *
-     * @return number[]
+     * @return string[]
      */
-    getStartDates(): number[];
+    getStartDates(): string[];
     /**
      * Summary text of the programme (stripped of html tags).
      *

package/protobuf/PartnerApi/PartnerApiOrganisation.d.ts

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

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

@@ -1,21 +0,0 @@
-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/PartnerApiProgramme.js

@@ -1,63 +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/PartnerApiProgramme.proto
-/* eslint-disable */
-import { Location } from "../Location.js";
-import { Logo } from "../Logo.js";
-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) : "",
-            summary: isSet(object.summary) ? globalThis.String(object.summary) : undefined,
-            logo: isSet(object.logo) ? Logo.fromJSON(object.logo) : 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) {
-        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.summary !== undefined) {
-            obj.summary = message.summary;
-        }
-        if (message.logo !== undefined) {
-            obj.logo = Logo.toJSON(message.logo);
-        }
-        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.timings?.length) {
-            obj.timings = message.timings.map((e) => Timing.toJSON(e));
-        }
-        return obj;
-    },
-};
-function isSet(value) {
-    return value !== null && value !== undefined;
-}

package/protobuf/PartnerApi/PartnerApiScholarship.d.ts

@@ -1,42 +0,0 @@
-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/PartnerApiScholarship.js

@@ -1,149 +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/PartnerApiScholarship.proto
-/* eslint-disable */
-import { Link } from "../Link.js";
-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,
-            scholarshipDetailsLink: isSet(object.scholarshipDetailsLink)
-                ? Link.fromJSON(object.scholarshipDetailsLink)
-                : 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) {
-        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.scholarshipDetailsLink !== undefined) {
-            obj.scholarshipDetailsLink = Link.toJSON(message.scholarshipDetailsLink);
-        }
-        if (message.funding !== undefined) {
-            obj.funding = PartnerApiFunding.toJSON(message.funding);
-        }
-        if (message.eligibility !== undefined) {
-            obj.eligibility = PartnerApiEligibility.toJSON(message.eligibility);
-        }
-        if (message.about !== undefined) {
-            obj.about = message.about;
-        }
-        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 PartnerApiFunding = {
-    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 PartnerApiEligibility = {
-    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;
-    },
-};
-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/src/clients/partner-api-organisation-client.d.ts

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

package/src/clients/partner-api-organisation-client.js

@@ -1,16 +0,0 @@
-import { PartnerApiOrganisation } from "../../protobuf/PartnerApi/PartnerApiOrganisation.js";
-import { ProtobufClient } from "./protobuf-client.js";
-export class PartnerApiOrganisationClient extends ProtobufClient {
-    constructModel(data) {
-        return PartnerApiOrganisation.fromJSON(data);
-    }
-    getModelName() {
-        return 'partner-api-organisation';
-    }
-    getVersion() {
-        return 'v1';
-    }
-    isPublic() {
-        return false;
-    }
-}

package/src/clients/partner-api-programs-client.d.ts

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

package/src/clients/partner-api-programs-client.js

@@ -1,16 +0,0 @@
-import { PartnerApiProgramme } from "../../protobuf/PartnerApi/PartnerApiProgramme.js";
-import { ProtobufClient } from "./protobuf-client.js";
-export class PartnerApiProgramsClient extends ProtobufClient {
-    constructModel(data) {
-        return PartnerApiProgramme.fromJSON(data);
-    }
-    getModelName() {
-        return 'partner-api-programs';
-    }
-    getVersion() {
-        return 'v1';
-    }
-    isPublic() {
-        return false;
-    }
-}

package/src/clients/partner-api-scholarship-client.d.ts

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

package/src/clients/partner-api-scholarship-client.js

@@ -1,16 +0,0 @@
-import { PartnerApiScholarship } from "../../protobuf/PartnerApi/PartnerApiScholarship.js";
-import { ProtobufClient } from "./protobuf-client.js";
-export class PartnerApiScholarshipClient extends ProtobufClient {
-    constructModel(data) {
-        return PartnerApiScholarship.fromJSON(data);
-    }
-    getModelName() {
-        return 'partner-api-scholarship';
-    }
-    getVersion() {
-        return 'v1';
-    }
-    isPublic() {
-        return false;
-    }
-}