@studyportals/domain-client 6.0.0 → 6.1.0-beta.1

package/package.json

@@ -1,52 +1,50 @@
-{
-	"name": "@studyportals/domain-client",
-	"version": "6.0.0",
-	"description": "Responsible for fetching data from the Domain API",
-	"main": "index.js",
-	"author": "StudyPortals B.V.",
-	"sideEffects": false,
-	"contributors": [
-		"braaibander <danny@studyportals.com>"
-	],
-	"license": "BSD-3-Clause",
-	"scripts": {
-		"test": "vitest run",
-		"test:watch": "vitest",
-		"coverage": "vitest run --coverage",
-		"lint": "eslint . --ext .ts --max-warnings=0",
-		"lint:fix": "eslint . --ext .ts --fix",
-		"pre-push": "npm run test && npm run coverage && npm run lint",
-		"prepare-dist": "npm run test  && rm -fR bin && npx tsc && 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-patch": "npm version patch && npm run prepare-dist && npm publish ./bin",
-		"publish-current": "npm run prepare-dist && npm publish ./bin"
-	},
-	"husky": {
-		"hooks": {
-			"pre-push": "npm run pre-push"
-		}
-	},
-	"dependencies": {
-
-	},
-	"devDependencies": {
-		"@studyportals/code-style": "^2.0.4",
-		"@types/node": "^24.1.0",
-		"@types/reflect-metadata": "^0.1.0",
-		"@typescript-eslint/eslint-plugin": "^4.8.1",
-		"@typescript-eslint/parser": "^4.8.1",
-		"eslint": "^7.13.0",
-		"eslint-plugin-import": "^2.22.1",
-		"eslint-plugin-mocha": "^10.1.0",
-		"husky": "^4.3.0",
-		"nyc": "^15.1.0",
-		"source-map-support": "^0.5.19",
-		"tslint": "^6.1.3",
-		"typemoq": "^2.1.0",
-		"vitest": "^3.2.4",
-		"@vitest/coverage-v8": "^3.2.4",
-		"typescript": "^5.9.2"
-	}
-}
+{
+	"name": "@studyportals/domain-client",
+	"version": "6.1.0-beta.1",
+	"description": "Responsible for fetching data from the Domain API",
+	"main": "index.js",
+	"author": "StudyPortals B.V.",
+	"sideEffects": false,
+	"contributors": [
+		"braaibander <danny@studyportals.com>"
+	],
+	"license": "BSD-3-Clause",
+	"scripts": {
+		"build": "tsc",
+		"test": "vitest run",
+		"test:watch": "vitest",
+		"coverage": "vitest run --coverage",
+		"lint": "eslint . --ext .ts --max-warnings=0",
+		"lint:fix": "eslint . --ext .ts --fix",
+		"pre-push": "npm run test && npm run coverage && npm run lint",
+		"prepare-dist": "npm run test  && rm -fR bin && npx tsc && 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-patch": "npm version patch && npm run prepare-dist && npm publish ./bin",
+		"publish-current": "npm run prepare-dist && npm publish ./bin"
+	},
+	"husky": {
+		"hooks": {
+			"pre-push": "npm run pre-push"
+		}
+	},
+	"devDependencies": {
+		"@studyportals/code-style": "^2.0.4",
+		"@types/node": "^24.2.1",
+		"@types/reflect-metadata": "^0.1.0",
+		"@typescript-eslint/eslint-plugin": "^4.8.1",
+		"@typescript-eslint/parser": "^4.8.1",
+		"@vitest/coverage-v8": "^3.2.4",
+		"eslint": "^7.13.0",
+		"eslint-plugin-import": "^2.22.1",
+		"eslint-plugin-mocha": "^10.1.0",
+		"husky": "^4.3.0",
+		"nyc": "^15.1.0",
+		"source-map-support": "^0.5.19",
+		"tslint": "^6.1.3",
+		"typemoq": "^2.1.0",
+		"typescript": "^5.9.2",
+		"vitest": "^3.2.4"
+	}
+}

package/src/models/organisation-search-document/i-organisation-search-document.d.ts

@@ -119,4 +119,34 @@ export interface IOrganisationSearchDocument {
      * @return boolean
      */
     isPublished(): boolean;
+    /**
+     * Gets the city IDs for Masters programmes offered by the organisation
+     *
+     * @return array<number>
+     */
+    getCityIdsForMasters(): number[];
+    /**
+     * Gets the city IDs for Bachelors programmes offered by the organisation
+     *
+     * @return array<number>
+     */
+    getCityIdsForBachelors(): number[];
+    /**
+     * Gets the city IDs for PhD programmes offered by the organisation
+     *
+     * @return array<number>
+     */
+    getCityIdsForPhds(): number[];
+    /**
+     * Gets the city IDs for Short Courses programmes offered by the organisation
+     *
+     * @return array<number>
+     */
+    getCityIdsForShortCourses(): number[];
+    /**
+     * Gets the city IDs for Distance Learning programmes offered by the organisation
+     *
+     * @return array<number>
+     */
+    getCityIdsForDistanceLearning(): number[];
 }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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