@studyportals/domain-client 3.6.0-0 → 3.6.0-2

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

@@ -0,0 +1,53 @@
+import { IDeadline, IStartDate } from "../../..";
+
+export interface ITiming {
+
+	/**
+	 * Get the IDeadline applicable for this type and programme.
+	 *
+	 * Note: In case of extendable start dates, all information in the
+	 * Deadline object has already been extended to the first available start
+	 * date.
+	 *
+	 * @return IDeadline
+	 * @throws PropertyNotAvailableException
+	 */
+	getDeadline(): IDeadline;
+
+	canShowDeadline(): boolean;
+
+	/**
+	 * Get the IStartDate applicable for this type and programme.
+	 *
+	 * Note: In case of extendable start dates, all information in the
+	 * StartDate objects has already been extended to the first available start
+	 * date.
+	 *
+	 * @return IStartDate
+	 * @throws PropertyNotAvailableException
+	 */
+	getStartDate(): IStartDate;
+
+	canShowStartDate(): boolean;
+
+	/**
+	 * Type of user the timing is applicable to (e.g. general, eea, national).
+	 *
+	 * @return string
+	 */
+	getType(): string;
+
+	/**
+	 * True if the programme allows to apply at any time (rolling application).
+	 *
+	 * @return boolean
+	 */
+	isApplyingAnytime(): boolean;
+
+	/**
+	 * True if the programme can start at any time (rolling admission).
+	 *
+	 * @return boolean
+	 */
+	isStartingAnytime(): boolean;
+}

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

@@ -0,0 +1,34 @@
+import { ITracking } from "../../..";
+
+export interface ITrackedLink {
+
+	/**
+	 * Get an optional text describing the link (typically <a>-tags contents).
+	 *
+	 * @return string
+	 * @throws PropertyNotAvailableException
+	 */
+	getDescription(): string;
+
+	canShowDescription(): boolean;
+
+	/**
+	 * Get an object containing all information needed to properly track a link.
+	 *
+	 * @return ITracking
+	 */
+	getTracking(): ITracking;
+
+	/**
+	 * 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/programme-card/i-tracking.ts

@@ -0,0 +1,55 @@
+import { IClickTrackingData } from "../../..";
+
+export interface ITracking {
+
+	/**
+	 * Get the value of the data-action attribute.
+	 *
+	 * @return string
+	 */
+	getAction(): string;
+
+	/**
+	 * Get all the data that is need to make click tracking possible
+	 *
+	 * @return IClickTrackingData
+	 */
+	getClickTrackingData(): IClickTrackingData;
+
+	canShowClickTrackingData(): boolean;
+
+	/**
+	 * Get the value of the data-description attribute.
+	 *
+	 * @return string
+	 */
+	getDescription(): string;
+
+	/**
+	 * Get the extra information value.
+	 *
+	 * @return string
+	 */
+	getExtra(): string;
+
+	/**
+	 * Get the value of the data-id attribute.
+	 *
+	 * @return number
+	 */
+	getId(): number;
+
+	/**
+	 * Get the value of the data-label attribute.
+	 *
+	 * @return string
+	 */
+	getLabel(): string;
+
+	/**
+	 * Get the value of the data-type attribute.
+	 *
+	 * @return string
+	 */
+	getType(): string;
+}

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

@@ -0,0 +1,16 @@
+import { IProgrammeCard } from "../../..";
+import { ModelClient } from "../../model-client";
+
+export class ProgrammeCardClient extends ModelClient<IProgrammeCard> {
+	protected getModelName(): string {
+		return 'programme-card';
+	}
+
+	protected getVersion(): string {
+		return 'v1';
+	}
+
+	public isPublic(): boolean {
+		return false;
+	}
+}

package/src/models/search-country-faq/i-search-country-faq.ts

@@ -0,0 +1,22 @@
+export interface ISearchCountryFaq {
+
+	/**
+	 * @return number
+	 */
+	getId(): number;
+
+	/**
+	 * @return string
+	 */
+	getName(): string;
+
+	/**
+	 * @return string
+	 */
+	getRankingCountryLink(): string;
+
+	/**
+	 * @return string[]
+	 */
+	getTopFiveUniversities(): string[];
+}

package/src/models/search-country-faq/public-search-country-faq-client.ts

@@ -0,0 +1,16 @@
+import { ISearchCountryFaq } from "../../..";
+import { ModelClient } from "../../model-client";
+
+export class PublicSearchCountryFaqClient extends ModelClient<ISearchCountryFaq> {
+	protected getModelName(): string {
+		return 'search-country-faq';
+	}
+
+	protected getVersion(): string {
+		return 'v1';
+	}
+
+	public isPublic(): boolean {
+		return true;
+	}
+}

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

@@ -0,0 +1,44 @@
+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/search-projection/i-geo-targeting-values.ts

@@ -0,0 +1,38 @@
+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/search-projection/i-organisation-values.ts

@@ -0,0 +1,46 @@
+export interface IOrganisationValues {
+
+	/**
+	 * Country ID of the top level organisation.
+	 *
+	 * @return number
+	 */
+	getCountryId(): number;
+
+	/**
+	 * ID of the programme's main organisation.
+	 *
+	 * First premium organisation or top level organisation.
+	 *
+	 * @return number
+	 */
+	getId(): number;
+
+	/**
+	 * Name of the programme's main organisation.
+	 *
+	 * First premium organisation or top level organisation.
+	 *
+	 * @return string
+	 */
+	getName(): string;
+
+	/**
+	 * List of all organisation IDs attached to the programme (main + sub).
+	 *
+	 * @return number[]
+	 */
+	getOrganisations(): number[];
+
+	/**
+	 * Region ID of the top level organisation.
+	 *
+	 * Currently only possible region ID is 38 (EEA region). All other regions
+	 * are ignored for this field.
+	 *
+	 * @return number
+	 */
+	getRegionId(): number;
+
+	canShowRegionId(): boolean;
+}

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

@@ -0,0 +1,43 @@
+export interface IPremiumValues {
+
+	/**
+	 * Bottom of the premium probability range (between 0.0 asn 1.0).
+	 *
+	 * @return number
+	 */
+	getPremiumBottom(): number;
+
+	canShowPremiumBottom(): boolean;
+
+	/**
+	 * CPM value attached to the premium listing.
+	 *
+	 * @return number
+	 */
+	getPremiumCpm(): number;
+
+	canShowPremiumCpm(): boolean;
+
+	/**
+	 * Top of the premium probability range (between 0.0 asn 1.0).
+	 *
+	 * @return number
+	 */
+	getPremiumTop(): number;
+
+	canShowPremiumTop(): boolean;
+
+	/**
+	 * Short hand premium type (sp, p, lp, slp, sslp, b).
+	 *
+	 * @return string
+	 */
+	getPremiumType(): string;
+
+	/**
+	 * Premium weight value used in Cloudsearch commercial sorting.
+	 *
+	 * @return number
+	 */
+	getPremiumValue(): number;
+}

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

@@ -0,0 +1,216 @@
+import { IGeoTargetingValues, IOrganisationValues, IPremiumValues, ITuitionValues } from "../../..";
+
+export interface ISearchProjection {
+
+	/**
+	 * List of area IDs where the programme is taught at (through venues).
+	 *
+	 * @return number[]
+	 */
+	getAreas(): number[];
+
+	/**
+	 * Current boost value for the programme (campaign automation).
+	 *
+	 * @return number
+	 */
+	getBoost(): number;
+
+	/**
+	 * Contents text of the programme (stripped of html tags).
+	 *
+	 * @return string
+	 */
+	getContents(): string;
+
+	/**
+	 * List of country IDs where the programme is taught at (through venues).
+	 *
+	 * @return number[]
+	 */
+	getCountries(): number[];
+
+	/**
+	 * Unformatted degree of the programme.
+	 *
+	 * @return string
+	 */
+	getDegree(): string;
+
+	/**
+	 * Formatted degree of the programme.
+	 *
+	 * @return string
+	 */
+	getDegreeFormatted(): string;
+
+	/**
+	 * List of intensity densities of the programme.
+	 *
+	 * @return string[]
+	 */
+	getDensity(): string[];
+
+	/**
+	 * Description text of the programme (stripped of html tags).
+	 *
+	 * @return string
+	 */
+	getDescription(): string;
+
+	/**
+	 * List of disciplines connected to the programme (includes parent IDs).
+	 *
+	 * @return number[]
+	 */
+	getDisciplines(): number[];
+
+	/**
+	 * List of educational forms.
+	 *
+	 * @return string[]
+	 */
+	getEducationalForms(): string[];
+
+	/**
+	 * Full time duration in days.
+	 *
+	 * @return number
+	 */
+	getFullTimeDuration(): number;
+
+	canShowFullTimeDuration(): boolean;
+
+	getGeoTargetingValues(): IGeoTargetingValues;
+
+	/**
+	 * Id of the programme.
+	 *
+	 * @return number
+	 */
+	getId(): number;
+
+	/**
+	 * List of language IDs the programme is taught in.
+	 *
+	 * @return number[]
+	 */
+	getLanguages(): number[];
+
+	/**
+	 * Study level of the programme.
+	 *
+	 * @return string
+	 */
+	getLevel(): string;
+
+	/**
+	 * Url of the logo to display (square if available, legacy otherwise).
+	 *
+	 * @return string
+	 */
+	getLogo(): string;
+
+	canShowLogo(): boolean;
+
+	/**
+	 * Url of the legacy logo to display.
+	 *
+	 * @return string
+	 */
+	getLogoOld(): string;
+
+	canShowLogoOld(): boolean;
+
+	/**
+	 * List of study methods.
+	 *
+	 * @return string[]
+	 */
+	getMethods(): string[];
+
+	getOrganisationValues(): IOrganisationValues;
+
+	/**
+	 * Part time duration in days.
+	 *
+	 * @return number
+	 */
+	getPartTimeDuration(): number;
+
+	canShowPartTimeDuration(): boolean;
+
+	getPremiumValues(): IPremiumValues;
+
+	/**
+	 * The programme's probability seed value (previously known as 'entropy').
+	 *
+	 * Should be a value between 0 and 4095.
+	 *
+	 * @return number
+	 */
+	getProbabilitySeed(): number;
+
+	/**
+	 * List of region IDs where the programme is taught at (through venues).
+	 *
+	 * Includes both the direct regions as the parent regions.
+	 *
+	 * @return number[]
+	 */
+	getRegions(): number[];
+
+	/**
+	 * List of special programme types (executive, joint, erasmus).
+	 *
+	 * @return string[]
+	 */
+	getSpecialStudy(): string[];
+
+	/**
+	 * List of the start months for the programme.
+	 *
+	 * @return number[]
+	 */
+	getStartDates(): number[];
+
+	/**
+	 * Summary text of the programme (stripped of html tags).
+	 *
+	 * @return string
+	 */
+	getSummary(): string;
+
+	/**
+	 * Title of the programme.
+	 *
+	 * @return string
+	 */
+	getTitle(): string;
+
+	getTuitionValues(): ITuitionValues;
+
+	canShowTuitionValues(): boolean;
+
+	/**
+	 * List of json encoded venue descriptions.
+	 *
+	 * Example of structure:
+	 * {
+	 *'city': 'Eindhoven',
+	 *'country': 'Netherlands',
+	 *'area': 'North Brabant',
+	 *'display_area': true
+	 * }
+	 *
+	 * @return string[]
+	 */
+	getVenues(): string[];
+
+	/**
+	 * Public status of the programme.
+	 *
+	 * @return boolean
+	 */
+	isPublic(): boolean;
+}

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

@@ -0,0 +1,63 @@
+export interface ITuitionValues {
+
+	/**
+	 * Tuition (converted to per year if possible) for EEA students.
+	 *
+	 * @return number
+	 */
+	getTuitionEea(): number;
+
+	canShowTuitionEea(): boolean;
+
+	/**
+	 * Tuition currency.
+	 *
+	 * @return number
+	 */
+	getTuitionEeaCurrency(): number;
+
+	canShowTuitionEeaCurrency(): boolean;
+
+	/**
+	 * Tuition (converted to per year if possible) for international students.
+	 *
+	 * @return number
+	 */
+	getTuitionInternational(): number;
+
+	canShowTuitionInternational(): boolean;
+
+	/**
+	 * Tuition currency.
+	 *
+	 * @return number
+	 */
+	getTuitionInternationalCurrency(): number;
+
+	canShowTuitionInternationalCurrency(): boolean;
+
+	/**
+	 * Tuition (converted to per year if possible) for national students.
+	 *
+	 * @return number
+	 */
+	getTuitionNational(): number;
+
+	canShowTuitionNational(): boolean;
+
+	/**
+	 * Tuition currency.
+	 *
+	 * @return number
+	 */
+	getTuitionNationalCurrency(): number;
+
+	canShowTuitionNationalCurrency(): boolean;
+
+	/**
+	 * Unit all tuition fees are provided in.
+	 *
+	 * @return number
+	 */
+	getTuitionUnitType(): number;
+}

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

@@ -0,0 +1,16 @@
+import { ISearchProjection } from "../../..";
+import { ModelClient } from "../../model-client";
+
+export class SearchProjectionClient extends ModelClient<ISearchProjection> {
+	protected getModelName(): string {
+		return 'search-projection';
+	}
+
+	protected getVersion(): string {
+		return 'v1';
+	}
+
+	public isPublic(): boolean {
+		return false;
+	}
+}

package/src/types/portal-map.ts

@@ -0,0 +1,3 @@
+import { PortalType } from "./portal-type";
+
+export type PortalMap = Map<PortalType, string>

package/src/types/portal-type.ts

@@ -0,0 +1,7 @@
+export enum PortalType {
+	MASTER= 'master',
+	BACHELOR = 'bachelor',
+	PHD = 'phd',
+	SHORT = 'short',
+	DISTANCE_LEARNING = 'distance_learning',
+}

package/src/types.ts

@@ -0,0 +1,4 @@
+export type Model = Record<string, Callable>;
+export type Callable = () => CallableReturnType|CallableReturnType[];
+export type CallableReturnType = AcceptedType | Model;
+export type AcceptedType = string | string[] | number | number[] | boolean | null | Date;