@studyportals/domain-client 6.0.0-1 → 6.0.0-10

package/src/factories/InternalLinkFactory.js

@@ -3,10 +3,15 @@ export class InternalLinkFactory {
     constructor(portalMap) {
         this.portalMap = portalMap;
     }
-    create(link) {
-        const portalBaseUrl = this.getPortalBaseUrl(link.getPortalType());
-        const path = link['getUrl']();
-        link['getUrl'] = () => portalBaseUrl + path;
+    create(link, parameters) {
+        const getPortalType = link['getPortalType'];
+        const portalType = getPortalType ? getPortalType() : null;
+        const portalBaseUrl = portalType ? this.getPortalBaseUrl(portalType) : '';
+        const getUrl = link['getUrl'];
+        if (getUrl) {
+            const path = getUrl();
+            link['getUrl'] = () => portalBaseUrl + path;
+        }
         return link;
     }
     getPortalBaseUrl(portalType) {
@@ -14,4 +19,3 @@ export class InternalLinkFactory {
         return url || '';
     }
 }
-//# sourceMappingURL=InternalLinkFactory.js.map

package/src/i-api-response.d.ts

@@ -1,6 +1,6 @@
 import { IModelDescription } from "./i-model-description";
 export interface IApiResponse {
     status: number;
-    data: Record<number, IModelDescription>;
+    data: Record<number, IModelDescription | string>;
     message: string;
 }

package/src/i-api-response.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-api-response.js.map

package/src/i-class-factory.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-class-factory.js.map

package/src/i-model-description.js

@@ -3,4 +3,3 @@ export function isModelDescription(arg) {
     // eslint-disable-next-line
     return arg && arg.class && (arg.func || arg.parameters);
 }
-//# sourceMappingURL=i-model-description.js.map

package/src/model-client.js

@@ -41,4 +41,3 @@ export class ModelClient {
         return this.modelFactory.fromDescriptions(descriptions);
     }
 }
-//# sourceMappingURL=model-client.js.map

package/src/model-factory.js

@@ -66,4 +66,3 @@ export class ModelFactory {
         });
     }
 }
-//# sourceMappingURL=model-factory.js.map

package/src/models/bestfit-programme/bestfit-programme-client.js

@@ -10,4 +10,3 @@ export class BestfitProgrammeClient extends ModelClient {
         return false;
     }
 }
-//# sourceMappingURL=bestfit-programme-client.js.map

package/src/models/bestfit-programme/i-best-fit-programme.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-best-fit-programme.js.map

package/src/models/bestfit-programme/i-city.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-city.js.map

package/src/models/bestfit-programme/i-english-requirements.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-english-requirements.js.map

package/src/models/bestfit-programme/i-g-p-a-requirement.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-g-p-a-requirement.js.map

package/src/models/bestfit-programme/i-living-cost.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-living-cost.js.map

package/src/models/bestfit-programme/i-tuition-fee.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-tuition-fee.js.map

package/src/models/common/i-city.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-city.js.map

package/src/models/common/i-country.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-country.js.map

package/src/models/common/i-english-requirements.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-english-requirements.js.map

package/src/models/common/i-g-p-a-requirement.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-g-p-a-requirement.js.map

package/src/models/common/i-internal-link.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-internal-link.js.map

package/src/models/common/i-logo.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-logo.js.map

package/src/models/common/i-review-rating.d.ts

@@ -0,0 +1,26 @@
+export interface IReviewRating {
+    /**
+     * The average rating of the reviews on 10-point scale.
+     *
+     * @return number
+     */
+    getAverage(): number;
+    /**
+     * The number of reviews that contributed to the average rating.
+     *
+     * @return number
+     */
+    getQuantity(): number;
+    /**
+     * Checks if the rating has enough reviews to be considered valid.
+     *
+     * @return boolean
+     */
+    hasEnoughQuantity(): boolean;
+    /**
+     * Gets the average star rating based on the average score on 5-point scale.
+     *
+     * @return number
+     */
+    getAverageStarRating(): number;
+}

package/src/models/common/i-review-rating.js

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

package/src/models/common/i-tuition-fee.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-tuition-fee.js.map

package/src/models/compare-programme/i-english-requirements.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-english-requirements.js.map

package/src/models/compare-programme/i-g-p-a-requirement.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-g-p-a-requirement.js.map

package/src/models/compare-programme/i-living-cost.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-living-cost.js.map

package/src/models/copilot-country/copilot-country-client.js

@@ -10,4 +10,3 @@ export class CopilotCountryClient extends ModelClient {
         return false;
     }
 }
-//# sourceMappingURL=copilot-country-client.js.map

package/src/models/copilot-country/i-copilot-country.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-copilot-country.js.map

package/src/models/copilot-country/i-copilot-ranking-card.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-copilot-ranking-card.js.map

package/src/models/copilot-programme/copilot-programme-client.js

@@ -10,4 +10,3 @@ export class CopilotProgrammeClient extends ModelClient {
         return false;
     }
 }
-//# sourceMappingURL=copilot-programme-client.js.map

package/src/models/copilot-programme/i-copilot-programme.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-copilot-programme.js.map

package/src/models/copilot-programme/i-deadline.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-deadline.js.map

package/src/models/copilot-programme/i-english-requirements.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-english-requirements.js.map

package/src/models/copilot-programme/i-g-p-a-requirement.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-g-p-a-requirement.js.map

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

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-geo-targeting-configuration.js.map

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

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-geo-targeting-values.js.map

package/src/models/copilot-programme/i-internal-link.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-internal-link.js.map

package/src/models/copilot-programme/i-link.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-link.js.map

package/src/models/copilot-programme/i-living-cost.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-living-cost.js.map

package/src/models/copilot-programme/i-start-date.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-start-date.js.map

package/src/models/copilot-programme/i-timing.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-timing.js.map

package/src/models/copilot-programme/i-tuition-values.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-tuition-values.js.map

package/src/models/customerio-organisation/customerio-organisation-client.js

@@ -10,4 +10,3 @@ export class CustomerIOOrganisationClient extends ModelClient {
         return false;
     }
 }
-//# sourceMappingURL=customerio-organisation-client.js.map

package/src/models/customerio-organisation/i-city.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-city.js.map

package/src/models/customerio-organisation/i-country.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-country.js.map

package/src/models/customerio-organisation/i-customer-i-o-organisation.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-customer-i-o-organisation.js.map

package/src/models/customerio-organisation/i-customer-io-organisation.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-customer-io-organisation.js.map

package/src/models/customerio-organisation/i-review.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-review.js.map

package/src/models/customerio-programme/customerio-programme-client.js

@@ -10,4 +10,3 @@ export class CustomerIOProgrammeClient extends ModelClient {
         return false;
     }
 }
-//# sourceMappingURL=customerio-programme-client.js.map

package/src/models/customerio-programme/i-country.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-country.js.map

package/src/models/customerio-programme/i-customer-i-o-programme.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-customer-i-o-programme.js.map

package/src/models/customerio-programme/i-customer-io-programme.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-customer-io-programme.js.map

package/src/models/customerio-programme/i-deadline.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-deadline.js.map

package/src/models/customerio-programme/i-english-requirements.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-english-requirements.js.map

package/src/models/customerio-programme/i-internal-link.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-internal-link.js.map

package/src/models/customerio-programme/i-logo.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-logo.js.map

package/src/models/customerio-programme/i-start-date.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-start-date.js.map

package/src/models/customerio-programme/i-timing.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-timing.js.map

package/src/models/customerio-programme/i-tuition-fee.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-tuition-fee.js.map

package/src/models/faq-static-content/i-faq-static-content.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-faq-static-content.js.map

package/src/models/faq-static-content/i-faq.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-faq.js.map

package/src/models/faq-static-content/i-static-content-url.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-static-content-url.js.map

package/src/models/faq-static-content/public-faq-static-content-client.js

@@ -10,4 +10,3 @@ export class PublicFaqStaticContentClient extends ModelClient {
         return true;
     }
 }
-//# sourceMappingURL=public-faq-static-content-client.js.map

package/src/models/organisation-card/i-organisation-card.d.ts

@@ -1,3 +1,4 @@
+import { IReviewRating } from "../common/i-review-rating";
 import { IRankingDiscipline } from "./i-ranking-discipline";
 export interface IOrganisationCard {
     getNumberOfProgrammesForBachelors(): number;
@@ -33,4 +34,5 @@ export interface IOrganisationCard {
     isNonProfitFunding(): boolean;
     isPublicFunding(): boolean;
     getCampaignType(): number;
+    getReviewRating(): IReviewRating | null;
 }

package/src/models/organisation-card/i-organisation-card.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-organisation-card.js.map

package/src/models/organisation-card/i-ranking-discipline.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-ranking-discipline.js.map

package/src/models/organisation-card/i-review-rating-domain.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-review-rating-domain.js.map

package/src/models/organisation-card/organisation-card-client.js

@@ -10,4 +10,3 @@ export class OrganisationCardClient extends ModelClient {
         return false;
     }
 }
-//# sourceMappingURL=organisation-card-client.js.map

package/src/models/organisation-for-search/i-organisation-for-search.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-organisation-for-search.js.map

package/src/models/organisation-for-search/public-organisation-for-search-client.js

@@ -10,4 +10,3 @@ export class PublicOrganisationForSearchClient extends ModelClient {
         return true;
     }
 }
-//# sourceMappingURL=public-organisation-for-search-client.js.map

package/src/models/organisation-search-document/i-organisation-search-document.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-organisation-search-document.js.map

package/src/models/organisation-search-document/organisation-search-document-client.js

@@ -10,4 +10,3 @@ export class OrganisationSearchDocumentClient extends ModelClient {
         return false;
     }
 }
-//# sourceMappingURL=organisation-search-document-client.js.map

package/src/models/programme-card/i-click-tracking-data.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-click-tracking-data.js.map

package/src/models/programme-card/i-cover.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-cover.js.map

package/src/models/programme-card/i-deadline.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-deadline.js.map

package/src/models/programme-card/i-duration.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-duration.js.map

package/src/models/programme-card/i-english-requirements.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-english-requirements.js.map

package/src/models/programme-card/i-g-p-a-requirement.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-g-p-a-requirement.js.map

package/src/models/programme-card/i-internal-link.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-internal-link.js.map

package/src/models/programme-card/i-link.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-link.js.map

package/src/models/programme-card/i-living-cost.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-living-cost.js.map

package/src/models/programme-card/i-location.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-location.js.map

package/src/models/programme-card/i-logo.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-logo.js.map

package/src/models/programme-card/i-optional-link.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-optional-link.js.map

package/src/models/programme-card/i-programme-card.d.ts

@@ -1,4 +1,5 @@
 import { ICover, IDuration, IEnglishRequirements, IGPARequirement, IInternalLink, ILink, ILivingCost, ILocation, ILogo, ITiming, ITrackedLink, ITracking, ITuitionFee } from "../../..";
+import { IReviewRating } from "../common/i-review-rating";
 export interface IProgrammeCard {
     /**
      * ISO code of the country the programme is taught.
@@ -202,4 +203,10 @@ export interface IProgrammeCard {
      * @return number
      */
     getCampaignType(): number | null;
+    /**
+     * Get the review rating of the programme.
+     *
+     * @return IReviewRating | null
+     */
+    getReviewRating(): IReviewRating | null;
 }

package/src/models/programme-card/i-programme-card.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-programme-card.js.map

package/src/models/programme-card/i-review-rating-domain.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-review-rating-domain.js.map

package/src/models/programme-card/i-start-date.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-start-date.js.map

package/src/models/programme-card/i-timing.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-timing.js.map

package/src/models/programme-card/i-tracked-link.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-tracked-link.js.map

package/src/models/programme-card/i-tracking.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-tracking.js.map

package/src/models/programme-card/i-tuition-fee.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-tuition-fee.js.map

package/src/models/programme-card/programme-card-client.js

@@ -10,4 +10,3 @@ export class ProgrammeCardClient extends ModelClient {
         return false;
     }
 }
-//# sourceMappingURL=programme-card-client.js.map

package/src/models/ranking-cards/i-ranking.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-ranking.js.map

package/src/models/scholarship-card/i-scholarship-card-v2.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-scholarship-card-v2.js.map

package/src/models/scholarship-card/i-scholarship-card.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-scholarship-card.js.map

package/src/models/scholarship-card/public-scholarship-card-client.js

@@ -10,4 +10,3 @@ export class PublicScholarshipCardClient extends ModelClient {
         return true;
     }
 }
-//# sourceMappingURL=public-scholarship-card-client.js.map

package/src/models/scholarship-card/scholarship-card-v2-client.js

@@ -10,4 +10,3 @@ export class ScholarshipCardV2Client extends ModelClient {
         return false;
     }
 }
-//# sourceMappingURL=scholarship-card-v2-client.js.map

package/src/models/scholarship-card-v2/i-scholarship-card.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-scholarship-card.js.map

package/src/models/scholarship-card-v2/scholarship-card-v2-client.js

@@ -10,4 +10,3 @@ export class ScholarshipCardV2Client extends ModelClient {
         return false;
     }
 }
-//# sourceMappingURL=scholarship-card-v2-client.js.map

package/src/models/scholarship-search-document/i-scholarship-search-document.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-scholarship-search-document.js.map

package/src/models/scholarship-search-document/scholarship-search-document-client.js

@@ -10,4 +10,3 @@ export class ScholarshipSearchDocumentClient extends ModelClient {
         return false;
     }
 }
-//# sourceMappingURL=scholarship-search-document-client.js.map

package/src/models/search-discipline/i-search-discipline.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-search-discipline.js.map

package/src/models/search-discipline/public-search-discipline-client.js

@@ -10,4 +10,3 @@ export class PublicSearchDisciplineClient extends ModelClient {
         return true;
     }
 }
-//# sourceMappingURL=public-search-discipline-client.js.map

package/src/models/search-projection/i-geo-targeting-configuration.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-geo-targeting-configuration.js.map

package/src/models/search-projection/i-geo-targeting-values.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-geo-targeting-values.js.map

package/src/models/search-projection/i-organisation-values.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-organisation-values.js.map

package/src/models/search-projection/i-premium-values.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-premium-values.js.map

package/src/models/search-projection/i-search-projection.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-search-projection.js.map

package/src/models/search-projection/i-tuition-values.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-tuition-values.js.map

package/src/models/search-projection/search-projection-client.js

@@ -10,4 +10,3 @@ export class SearchProjectionClient extends ModelClient {
         return false;
     }
 }
-//# sourceMappingURL=search-projection-client.js.map

package/src/models/sitemap-articles-info/i-sitemap-article-info.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-sitemap-article-info.js.map

package/src/models/sitemap-articles-info/sitemap-articles-info-client.js

@@ -10,4 +10,3 @@ export class SitemapArticlesInfoClient extends ModelClient {
         return false;
     }
 }
-//# sourceMappingURL=sitemap-articles-info-client.js.map

package/src/models/sitemap-cities-info/i-sitemap-city-info.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-sitemap-city-info.js.map

package/src/models/sitemap-cities-info/sitemap-cities-info-client.js

@@ -10,4 +10,3 @@ export class SitemapCitiesInfoClient extends ModelClient {
         return false;
     }
 }
-//# sourceMappingURL=sitemap-cities-info-client.js.map