@studyportals/domain-client 6.0.0-6 → 6.0.0-8

package/index.d.ts

@@ -34,6 +34,8 @@ import { IInternalLink } from "./src/models/customerio-programme/i-internal-link
 import { ICustomerIOProgramme } from "./src/models/customerio-programme/i-customer-io-programme";
 import { CustomerIOProgrammeClient } from "./src/models/customerio-programme/customerio-programme-client";
 import { IFaqStaticContent } from "./src/models/faq-static-content/i-faq-static-content";
+import { IFaq } from "./src/models/faq-static-content/i-faq";
+import { IStaticContentUrl } from "./src/models/faq-static-content/i-static-content-url";
 import { PublicFaqStaticContentClient } from "./src/models/faq-static-content/public-faq-static-content-client";
 import { ISitemapProgrammeInfo } from "./src/models/sitemap-programme-info/i-sitemap-programme-info";
 import { SitemapProgrammeInfoClient } from "./src/models/sitemap-programme-info/sitemap-programme-info-client";
@@ -80,6 +82,7 @@ import { CopilotProgrammeClient } from "./src/models/copilot-programme/copilot-p
 import { ICopilotCountry } from "./src/models/copilot-country/i-copilot-country";
 import { CopilotCountryClient } from "./src/models/copilot-country/copilot-country-client";
 import { ICopilotRankingCard } from "./src/models/copilot-country/i-copilot-ranking-card";
-export { BadRequestException, ClientException, InternalServerException, NotFoundException, PropertyNotAvailableException, ICover, ILink, IOptionalLink, ILocation, IClickTrackingData, ITracking, IDuration, IDeadline, IStartDate, ITiming, ITrackedLink, IProgrammeCard, ProgrammeCardClient, ITuitionValues, IPremiumValues, IOrganisationValues, IGeoTargetingConfiguration, IGeoTargetingValues, ISearchProjection, SearchProjectionClient, ILivingCost, IGPARequirement, IBestFitProgramme, BestfitProgrammeClient, ILogo, ITuitionFee, IEnglishRequirements, IInternalLink, ICustomerIOProgramme, CustomerIOProgrammeClient, IFaqStaticContent, PublicFaqStaticContentClient, ISitemapProgrammeInfo, SitemapProgrammeInfoClient, ISitemapCountryInfo, SitemapCountriesInfoClient, IDegreeInfo, ISitemapCountryDegreeInfo, SitemapCountryDegreeInfoClient, ISearchDiscipline, PublicSearchDisciplineClient, ISitemapDisciplineInfo, SitemapDisciplinesInfoClient, ICountry, ICity, IReview, ICustomerIOOrganisation, CustomerIOOrganisationClient, ISitemapOrganisationInfo, SitemapOrganisationsInfoClient, IOrganisationSearchDocument, OrganisationSearchDocumentClient, ISitemapRankingsInfo, SitemapRankingsInfoClient, ISitemapArticleInfo, SitemapArticlesInfoClient, ISitemapCityInfo, SitemapCitiesInfoClient, IScholarshipCard, PublicScholarshipCardClient, ScholarshipCardV2Client, IScholarshipSearchDocument, ScholarshipSearchDocumentClient, IRanking, PortalType, PortalMap, ModelClient, IOrganisationForSearch, PublicOrganisationForSearchClient, IOrganisationCard, IRankingDiscipline, OrganisationCardClient, ICopilotProgramme, ICopilotCountry, CopilotProgrammeClient, CopilotCountryClient, ICopilotRankingCard };
+import { IReviewRating } from "./src/models/common/i-review-rating";
+export { BadRequestException, ClientException, InternalServerException, NotFoundException, PropertyNotAvailableException, ICover, ILink, IOptionalLink, ILocation, IClickTrackingData, ITracking, IDuration, IDeadline, IStartDate, ITiming, ITrackedLink, IProgrammeCard, ProgrammeCardClient, ITuitionValues, IPremiumValues, IOrganisationValues, IGeoTargetingConfiguration, IGeoTargetingValues, ISearchProjection, SearchProjectionClient, ILivingCost, IGPARequirement, IBestFitProgramme, BestfitProgrammeClient, ILogo, ITuitionFee, IEnglishRequirements, IInternalLink, ICustomerIOProgramme, CustomerIOProgrammeClient, IFaqStaticContent, PublicFaqStaticContentClient, IFaq, IStaticContentUrl, ISitemapProgrammeInfo, SitemapProgrammeInfoClient, ISitemapCountryInfo, SitemapCountriesInfoClient, IDegreeInfo, ISitemapCountryDegreeInfo, SitemapCountryDegreeInfoClient, ISearchDiscipline, PublicSearchDisciplineClient, ISitemapDisciplineInfo, SitemapDisciplinesInfoClient, ICountry, ICity, IReview, ICustomerIOOrganisation, CustomerIOOrganisationClient, ISitemapOrganisationInfo, SitemapOrganisationsInfoClient, IOrganisationSearchDocument, OrganisationSearchDocumentClient, ISitemapRankingsInfo, SitemapRankingsInfoClient, ISitemapArticleInfo, SitemapArticlesInfoClient, ISitemapCityInfo, SitemapCitiesInfoClient, IScholarshipCard, PublicScholarshipCardClient, ScholarshipCardV2Client, IScholarshipSearchDocument, ScholarshipSearchDocumentClient, IRanking, PortalType, PortalMap, ModelClient, IOrganisationForSearch, PublicOrganisationForSearchClient, IOrganisationCard, IRankingDiscipline, OrganisationCardClient, ICopilotProgramme, ICopilotCountry, CopilotProgrammeClient, CopilotCountryClient, ICopilotRankingCard, IReviewRating };
 export * from './src/clients';
 export * from './protobuf';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@studyportals/domain-client",
-	"version": "6.0.0-6",
+	"version": "6.0.0-8",
 	"description": "Responsible for fetching data from the Domain API",
 	"main": "index.js",
 	"author": "StudyPortals B.V.",
@@ -30,7 +30,8 @@
 	},
 	"dependencies": {
 		"@vitest/coverage-v8": "^3.2.4",
-		"typescript": "^5.9.2"
+		"typescript": "^5.9.2",
+		"fflate": "^0.8.2"
 	},
 	"devDependencies": {
 		"@bufbuild/protobuf": "^2.6.2",
@@ -43,7 +44,6 @@
 		"@types/reflect-metadata": "^0.1.0",
 		"@typescript-eslint/eslint-plugin": "^4.8.1",
 		"@typescript-eslint/parser": "^4.8.1",
-		"barrelsby": "^2.8.1",
 		"eslint": "^7.13.0",
 		"eslint-plugin-import": "^2.22.1",
 		"eslint-plugin-mocha": "^10.1.0",

package/src/domain-client.d.ts

@@ -1,5 +1,4 @@
-import { IModelDescription } from "./i-model-description";
-export declare class DomainClient {
+export declare class DomainClient<T> {
     readonly baseUrl: string;
     readonly apiKey: string | undefined;
     readonly model: string;
@@ -7,7 +6,7 @@ export declare class DomainClient {
     readonly isPublic: boolean;
     readonly seed: number;
     constructor(baseUrl: string, apiKey: string | undefined, model: string, version: string, isPublic: boolean, seed: number);
-    doRequest(ids: number[]): Promise<IModelDescription[]>;
+    doRequest(ids: number[]): Promise<T[]>;
     private handleErrors;
     private buildUrl;
     private shouldAddPublicPrefix;

package/src/domain-client.js

@@ -1,6 +1,8 @@
 import { BadRequestException } from "./exceptions/bad-request-exception";
 import { InternalServerException } from "./exceptions/internal-server-exception";
 import { NotFoundException } from "./exceptions/not-found-exception";
+import { decompressSync } from 'fflate';
+const decoder = new TextDecoder();
 export class DomainClient {
     baseUrl;
     apiKey;
@@ -30,7 +32,18 @@ export class DomainClient {
             }
             const models = [];
             for (const id of ids) {
-                const modelData = data.data[id];
+                let modelData = data.data[id];
+                if (typeof modelData === 'string') {
+                    try {
+                        const bytes = Uint8Array.from(Buffer.from(modelData, 'base64'));
+                        const decompressedBytes = decompressSync(bytes);
+                        modelData = JSON.parse(decoder.decode(decompressedBytes));
+                    }
+                    catch (error) {
+                        console.error(error);
+                        continue;
+                    }
+                }
                 if (!modelData) {
                     continue;
                 }
@@ -39,6 +52,7 @@ export class DomainClient {
             return models;
         }
         catch (error) {
+            console.error('Error fetching data from API:', error);
             if (error instanceof InternalServerException || error instanceof BadRequestException || error instanceof NotFoundException) {
                 throw error;
             }

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/models/bestfit-programme/i-english-requirements.d.ts

@@ -0,0 +1,51 @@
+export interface IEnglishRequirements {
+    /**
+     * Required score for Cambridge english
+     *
+     * @return number
+     */
+    getCambridgeEnglish(): number;
+    canShowCambridgeEnglish(): boolean;
+    /**
+     * Required score for Duolingo
+     *
+     * @return number
+     */
+    getDuolingo(): number;
+    canShowDuolingo(): boolean;
+    /**
+     * Required score for IELTS tests
+     *
+     * @return number
+     */
+    getIELTS(): number;
+    canShowIELTS(): boolean;
+    /**
+     * Required score for OTE
+     *
+     * @return number
+     */
+    getOte(): number;
+    canShowOte(): boolean;
+    /**
+     * Required score for PTE
+     *
+     * @return number
+     */
+    getPTE(): number;
+    canShowPTE(): boolean;
+    /**
+     * Required score for TOEFL internet
+     *
+     * @return number
+     */
+    getTOEFLInternet(): number;
+    canShowTOEFLInternet(): boolean;
+    /**
+     * Required score for TOEFL paper
+     *
+     * @return number
+     */
+    getTOEFLPaper(): number;
+    canShowTOEFLPaper(): boolean;
+}

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

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

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

@@ -0,0 +1,20 @@
+export interface IGPARequirement {
+    /**
+     * The used GPA scale for this requirement
+     *
+     * @return string
+     */
+    getScale(): string;
+    /**
+     * Required minimum score.
+     *
+     * @return string
+     */
+    getScore(): string;
+    /**
+     * Is GPA recommended or required.
+     *
+     * @return boolean
+     */
+    isRequired(): boolean;
+}

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

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

package/src/models/bestfit-programme/i-tuition-fee.d.ts

@@ -0,0 +1,50 @@
+export interface ITuitionFee {
+    /**
+     * Get the tuition amount per unit in the provided currency.
+     *
+     * Note: all transformable units will be converted to yearly amounts. This
+     * includes per semester and full programme tuition fees.
+     *
+     * @return number
+     */
+    getAmount(): number;
+    /**
+     * Get the applicable currency.
+     *
+     * @return string
+     */
+    getCurrency(): string;
+    /**
+     * Get the original tuition amount before any transformation step.
+     *
+     * @return number
+     */
+    getOriginalAmount(): number;
+    /**
+     * Get the original tuition unit before any transformation step.
+     *
+     * @return string
+     */
+    getOriginalUnit(): string;
+    /**
+     * Get targeted audience (national, international, eea, etc).
+     *
+     * @return string
+     */
+    getTarget(): string;
+    /**
+     * Get the unit the tuition fee applies for.
+     *
+     * Note: all transformable units will be converted to 'year'. This means
+     * this value will be either 'year', 'module' or 'credit'.
+     *
+     * @return string
+     */
+    getUnit(): string;
+    /**
+     * True if the study is free for this target audience.
+     *
+     * @return boolean
+     */
+    isFree(): boolean;
+}

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

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

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/compare-programme/i-english-requirements.d.ts

@@ -0,0 +1,51 @@
+export interface IEnglishRequirements {
+    /**
+     * Required score for Cambridge english
+     *
+     * @return number
+     */
+    getCambridgeEnglish(): number;
+    canShowCambridgeEnglish(): boolean;
+    /**
+     * Required score for Duolingo
+     *
+     * @return number
+     */
+    getDuolingo(): number;
+    canShowDuolingo(): boolean;
+    /**
+     * Required score for IELTS tests
+     *
+     * @return number
+     */
+    getIELTS(): number;
+    canShowIELTS(): boolean;
+    /**
+     * Required score for OTE
+     *
+     * @return number
+     */
+    getOte(): number;
+    canShowOte(): boolean;
+    /**
+     * Required score for PTE
+     *
+     * @return number
+     */
+    getPTE(): number;
+    canShowPTE(): boolean;
+    /**
+     * Required score for TOEFL internet
+     *
+     * @return number
+     */
+    getTOEFLInternet(): number;
+    canShowTOEFLInternet(): boolean;
+    /**
+     * Required score for TOEFL paper
+     *
+     * @return number
+     */
+    getTOEFLPaper(): number;
+    canShowTOEFLPaper(): boolean;
+}

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

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

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

@@ -0,0 +1,20 @@
+export interface IGPARequirement {
+    /**
+     * The used GPA scale for this requirement
+     *
+     * @return string
+     */
+    getScale(): string;
+    /**
+     * Required minimum score.
+     *
+     * @return string
+     */
+    getScore(): string;
+    /**
+     * Is GPA recommended or required.
+     *
+     * @return boolean
+     */
+    isRequired(): boolean;
+}

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

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

package/src/models/compare-programme/i-living-cost.d.ts

@@ -0,0 +1,20 @@
+export interface ILivingCost {
+    /**
+     * Get the applicable currency.
+     *
+     * @return string
+     */
+    getCurrency(): string;
+    /**
+     * Get the maximum living cost in the provided currency.
+     *
+     * @return number
+     */
+    getMax(): number;
+    /**
+     * Get the minimum living cost in the provided currency.
+     *
+     * @return number
+     */
+    getMin(): number;
+}

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

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

package/src/models/copilot-programme/i-deadline.d.ts

@@ -0,0 +1,20 @@
+export interface IDeadline {
+    /**
+     * Get the date this deadline expires on.
+     *
+     * @return Date
+     */
+    getDate(): Date;
+    /**
+     * Get the deadline type (e.g. general, national, eea, etc).
+     *
+     * @return string
+     */
+    getType(): string;
+    /**
+     * True if the deadline has passed (e.g. you can't apply anymore).
+     *
+     * @return boolean
+     */
+    isPassed(): boolean;
+}

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

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

package/src/models/copilot-programme/i-english-requirements.d.ts

@@ -0,0 +1,51 @@
+export interface IEnglishRequirements {
+    /**
+     * Required score for Cambridge english
+     *
+     * @return number
+     */
+    getCambridgeEnglish(): number;
+    canShowCambridgeEnglish(): boolean;
+    /**
+     * Required score for Duolingo
+     *
+     * @return number
+     */
+    getDuolingo(): number;
+    canShowDuolingo(): boolean;
+    /**
+     * Required score for IELTS tests
+     *
+     * @return number
+     */
+    getIELTS(): number;
+    canShowIELTS(): boolean;
+    /**
+     * Required score for OTE
+     *
+     * @return number
+     */
+    getOte(): number;
+    canShowOte(): boolean;
+    /**
+     * Required score for PTE
+     *
+     * @return number
+     */
+    getPTE(): number;
+    canShowPTE(): boolean;
+    /**
+     * Required score for TOEFL internet
+     *
+     * @return number
+     */
+    getTOEFLInternet(): number;
+    canShowTOEFLInternet(): boolean;
+    /**
+     * Required score for TOEFL paper
+     *
+     * @return number
+     */
+    getTOEFLPaper(): number;
+    canShowTOEFLPaper(): boolean;
+}

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

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

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

@@ -0,0 +1,20 @@
+export interface IGPARequirement {
+    /**
+     * The used GPA scale for this requirement
+     *
+     * @return string
+     */
+    getScale(): string;
+    /**
+     * Required minimum score.
+     *
+     * @return string
+     */
+    getScore(): string;
+    /**
+     * Is GPA recommended or required.
+     *
+     * @return boolean
+     */
+    isRequired(): boolean;
+}

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

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

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

@@ -0,0 +1,38 @@
+export interface IGeoTargetingConfiguration {
+    /**
+     * Bit set 1 of targeted country ID information.
+     *
+     * @return number
+     */
+    getBit1(): number;
+    /**
+     * Bit set 2 of targeted country ID information.
+     *
+     * @return number
+     */
+    getBit2(): number;
+    /**
+     * Bit set 3 of targeted country ID information.
+     *
+     * @return number
+     */
+    getBit3(): number;
+    /**
+     * Bit set 4 of targeted country ID information.
+     *
+     * @return number
+     */
+    getBit4(): number;
+    /**
+     * Bit set 5 of targeted country ID information.
+     *
+     * @return number
+     */
+    getBit5(): number;
+    /**
+     * List of all configured country IDs.
+     *
+     * @return number[]
+     */
+    getTargetedCountries(): number[];
+}

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

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

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

@@ -0,0 +1,30 @@
+import { IGeoTargetingConfiguration } from "../../..";
+export interface IGeoTargetingValues {
+    /**
+     * Geo-targeting configuration for "light premium" listing.
+     *
+     * @return IGeoTargetingConfiguration
+     */
+    getLightPremium(): IGeoTargetingConfiguration;
+    canShowLightPremium(): boolean;
+    /**
+     * Geo-targeting configuration for "premium" listing.
+     *
+     * @return IGeoTargetingConfiguration
+     */
+    getPremium(): IGeoTargetingConfiguration;
+    canShowPremium(): boolean;
+    /**
+     * Geo-targeting configuration for "super premium" listing.
+     *
+     * @return IGeoTargetingConfiguration
+     */
+    getSuperPremium(): IGeoTargetingConfiguration;
+    canShowSuperPremium(): boolean;
+    /**
+     * Programme has active geo-targeting settings.
+     *
+     * @return boolean
+     */
+    isGeoTargeted(): boolean;
+}

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

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

package/src/models/copilot-programme/i-internal-link.d.ts

@@ -0,0 +1,28 @@
+export interface IInternalLink {
+    /**
+     * Get an optional text describing the link (typically <a>-tags contents).
+     *
+     * @return string
+     * @throws PropertyNotAvailableException
+     */
+    getDescription(): string;
+    canShowDescription(): boolean;
+    /**
+     * Returns on which portal a this link should link towards.
+     *
+     * @return string
+     */
+    getPortalType(): string;
+    /**
+     * Get the url to refer to.
+     *
+     * Note that the url provided is always a relative URL. A base URL is needed
+     * to make it a full valid path.
+     * The only exception is when an external link is provided (meaning, outside
+     * of StudyPortals-maintained domains). In this case a full url will be
+     * provided.
+     *
+     * @return string
+     */
+    getUrl(): string;
+}

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

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

package/src/models/copilot-programme/i-link.d.ts

@@ -0,0 +1,22 @@
+export interface ILink {
+    /**
+     * Get an optional text describing the link (typically <a>-tags contents).
+     *
+     * @return string
+     * @throws PropertyNotAvailableException
+     */
+    getDescription(): string;
+    canShowDescription(): boolean;
+    /**
+     * Get the url to refer to.
+     *
+     * Note that the url provided is always a relative URL. A base URL is needed
+     * to make it a full valid path.
+     * The only exception is when an external link is provided (meaning, outside
+     * of StudyPortals-maintained domains). In this case a full url will be
+     * provided.
+     *
+     * @return string
+     */
+    getUrl(): string;
+}

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

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

package/src/models/copilot-programme/i-living-cost.d.ts

@@ -0,0 +1,20 @@
+export interface ILivingCost {
+    /**
+     * Get the applicable currency.
+     *
+     * @return string
+     */
+    getCurrency(): string;
+    /**
+     * Get the maximum living cost in the provided currency.
+     *
+     * @return number
+     */
+    getMax(): number;
+    /**
+     * Get the minimum living cost in the provided currency.
+     *
+     * @return number
+     */
+    getMin(): number;
+}

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

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