@studyportals/domain-client 3.6.0-2 → 3.6.1-beta.1

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

@@ -0,0 +1,37 @@
+export interface IEnglishRequirements {
+    /**
+     * Required score for Duolingo
+     *
+     * @return number
+     */
+    getDuolingo(): number;
+    canShowDuolingo(): boolean;
+    /**
+     * Required score for IELTS tests
+     *
+     * @return number
+     */
+    getIELTS(): number;
+    canShowIELTS(): 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/dotdigital-programme/i-english-requirements.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=i-english-requirements.js.map

package/src/models/dotdigital-programme/i-english-requirements.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-english-requirements.js","sourceRoot":"","sources":["../../../../src/models/dotdigital-programme/i-english-requirements.ts"],"names":[],"mappings":""}

package/src/models/dotdigital-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/dotdigital-programme/i-internal-link.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=i-internal-link.js.map

package/src/models/dotdigital-programme/i-internal-link.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-internal-link.js","sourceRoot":"","sources":["../../../../src/models/dotdigital-programme/i-internal-link.ts"],"names":[],"mappings":""}

package/src/models/dotdigital-programme/i-logo.d.ts

@@ -0,0 +1,14 @@
+export interface ILogo {
+    /**
+     * Get the file ID of the logo.
+     *
+     * @return number
+     */
+    getId(): number;
+    /**
+     * Get the imgix URL of the logo.
+     *
+     * @return string
+     */
+    getSource(): string;
+}

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

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=i-logo.js.map

package/src/models/dotdigital-programme/i-logo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-logo.js","sourceRoot":"","sources":["../../../../src/models/dotdigital-programme/i-logo.ts"],"names":[],"mappings":""}

package/src/models/dotdigital-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/dotdigital-programme/i-tuition-fee.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=i-tuition-fee.js.map

package/src/models/dotdigital-programme/i-tuition-fee.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-tuition-fee.js","sourceRoot":"","sources":["../../../../src/models/dotdigital-programme/i-tuition-fee.ts"],"names":[],"mappings":""}

package/src/models/programme-card/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/programme-card/i-internal-link.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=i-internal-link.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"i-internal-link.js","sourceRoot":"","sources":["../../../../src/models/programme-card/i-internal-link.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,14 @@
+export interface ILogo {
+    /**
+     * Get the file ID of the logo.
+     *
+     * @return number
+     */
+    getId(): number;
+    /**
+     * Get the imgix URL of the logo.
+     *
+     * @return string
+     */
+    getSource(): string;
+}

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

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=i-logo.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"i-logo.js","sourceRoot":"","sources":["../../../../src/models/programme-card/i-logo.ts"],"names":[],"mappings":""}

package/src/models/programme-card/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/programme-card/i-tuition-fee.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=i-tuition-fee.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"i-tuition-fee.js","sourceRoot":"","sources":["../../../../src/models/programme-card/i-tuition-fee.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,26 @@
+export interface ISearchDiscipline {
+    /**
+     * @return string | null
+     */
+    getIcon(): string | null;
+    /**
+     * @return number
+     */
+    getId(): number;
+    /**
+     * @return string
+     */
+    getName(): string;
+    /**
+     * @return string | null
+     */
+    getOldVirtualPath(): string | null;
+    /**
+     * @return number | null
+     */
+    getParentId(): number | null;
+    /**
+     * @return string
+     */
+    getVirtualPath(): string;
+}

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

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=i-search-discipline.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"i-search-discipline.js","sourceRoot":"","sources":["../../../../src/models/search-discipline/i-search-discipline.ts"],"names":[],"mappings":""}

package/src/models/search-discipline/public-search-discipline-client.d.ts

@@ -0,0 +1,7 @@
+import { ISearchDiscipline } from "../../..";
+import { ModelClient } from "../../model-client";
+export declare class PublicSearchDisciplineClient extends ModelClient<ISearchDiscipline> {
+    protected getModelName(): string;
+    protected getVersion(): string;
+    isPublic(): boolean;
+}

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

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PublicSearchDisciplineClient = void 0;
+const model_client_1 = require("../../model-client");
+class PublicSearchDisciplineClient extends model_client_1.ModelClient {
+    getModelName() {
+        return 'search-discipline';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return true;
+    }
+}
+exports.PublicSearchDisciplineClient = PublicSearchDisciplineClient;
+//# sourceMappingURL=public-search-discipline-client.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"public-search-discipline-client.js","sourceRoot":"","sources":["../../../../src/models/search-discipline/public-search-discipline-client.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AAEjD,MAAa,4BAA6B,SAAQ,0BAA8B;IACrE,YAAY;QACrB,OAAO,mBAAmB,CAAC;IAC5B,CAAC;IAES,UAAU;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,OAAO,IAAI,CAAC;IACb,CAAC;CACD;AAZD,oEAYC"}

package/src/models/sitemap-rankings-info/i-sitemap-rankings-info.d.ts

@@ -0,0 +1,10 @@
+export interface ISitemapRankingsInfo {
+    /**
+     * @return number
+     */
+    getId(): number;
+    /**
+     * @return string
+     */
+    getPath(): string;
+}

package/src/models/sitemap-rankings-info/i-sitemap-rankings-info.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=i-sitemap-rankings-info.js.map

package/src/models/sitemap-rankings-info/i-sitemap-rankings-info.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-sitemap-rankings-info.js","sourceRoot":"","sources":["../../../../src/models/sitemap-rankings-info/i-sitemap-rankings-info.ts"],"names":[],"mappings":""}

package/src/models/sitemap-rankings-info/sitemap-rankings-info-client.d.ts

@@ -0,0 +1,7 @@
+import { ISitemapRankingsInfo } from "../../..";
+import { ModelClient } from "../../model-client";
+export declare class SitemapRankingsInfoClient extends ModelClient<ISitemapRankingsInfo> {
+    protected getModelName(): string;
+    protected getVersion(): string;
+    isPublic(): boolean;
+}

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

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SitemapRankingsInfoClient = void 0;
+const model_client_1 = require("../../model-client");
+class SitemapRankingsInfoClient extends model_client_1.ModelClient {
+    getModelName() {
+        return 'sitemap-rankings-info';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}
+exports.SitemapRankingsInfoClient = SitemapRankingsInfoClient;
+//# sourceMappingURL=sitemap-rankings-info-client.js.map

package/src/models/sitemap-rankings-info/sitemap-rankings-info-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sitemap-rankings-info-client.js","sourceRoot":"","sources":["../../../../src/models/sitemap-rankings-info/sitemap-rankings-info-client.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AAEjD,MAAa,yBAA0B,SAAQ,0BAAiC;IACrE,YAAY;QACrB,OAAO,uBAAuB,CAAC;IAChC,CAAC;IAES,UAAU;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,OAAO,KAAK,CAAC;IACd,CAAC;CACD;AAZD,8DAYC"}

package/src/types/portal-map.d.ts

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

package/src/{types.ts → types.d.ts}

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

package/.eslintignore

@@ -1,3 +0,0 @@
-**/node_modules/*
-**/bin/*
-**/tests/*

package/.eslintrc.js

@@ -1,12 +0,0 @@
-module.exports = {
-    root: true,
-    env: {
-        node: true
-    },
-    rules: {
-        "no-shadow": "off",
-    },
-    extends: [
-        './node_modules/@studyportals/code-style/.eslintrc.js'
-    ]
-}