@studyportals/domain-client 3.6.0-2 → 3.6.0

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/{bin/src → src}/models/programme-card/i-programme-card.d.ts

@@ -98,6 +98,7 @@ export interface IProgrammeCard {
     getTracking(): ITracking;
     /**
      * Get all tuition fees of the programme.
+     *
      * @return ITuitionFee[]
      */
     getTuitionFees(): ITuitionFee[];

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/.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'
-    ]
-}

package/.github/dependabot.yml

@@ -1,17 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: npm
-    directory: "/"
-    schedule:
-      interval: daily
-      time: "04:00"
-    open-pull-requests-limit: 10
-    reviewers:
-      - studyportals/plop
-    labels:
-      - component-library
-    allow:
-      - dependency-name: "@studyportals/*"
-    ignore:
-      - dependency-name: "@studyportals/*"
-        update-types: ["version-update:semver-patch"]

package/.github/stale.yml

@@ -1,10 +0,0 @@
-daysUntilStale: 14
-daysUntilClose: 46
-exemptLabels:
-  - pinned
-staleLabel: stale
-markComment: >
-  This issue has been automatically marked as stale because it has not had
-  recent activity. It will be closed if no further activity occurs. Thank you
-  for your contributions.
-closeComment: false

package/.mocharc.yml

@@ -1,3 +0,0 @@
-require:
-  - source-map-support/register
-  - ts-node/register

package/.nycrc

@@ -1,15 +0,0 @@
-{
-  "all": true,
-  "check-coverage": true,
-  "reporter": "text",
-  "exclude": [
-    "src/models/**/*.ts",
-    "src/i-*.ts",
-    "tests/**/*.ts",
-    "**/*.js"
-  ],
-  "branches": 100,
-  "lines": 100,
-  "functions": 100,
-  "statements": 100
-}

package/README.md

@@ -1,117 +0,0 @@
-# Domain Client
-
-A lightweight client for fetching data from the Domain API and returning it as 
-strongly typed classes defined by the `Domain API`. 
-
-## Installation 
-
-```
-npm install @studyportals/domain-client --save
-```
-
-## Publishing new version
-To publish a new version to npm run one of the following commnads
-```bash
-npm run publish-beta # Increase the beta version and publishes
-npm run publish-major # Increases the major version publishes
-npm run publish-minor # Increases the minor version and publishes
-npm run publish-patch # Increases the patch version and publishes
-npm run publish-current # Publishes the current version. 
-```
-
-## Default usage
-
-Instantiate your client class (_ProgrammeCard client as example_) with all 
-parameters:
-```typescript
-const client = new ProgrammeCardClient(
-    domainApiUrl, // The url to the Domain API endpoint
-    apiKey, // The API key provided by PLOP for your implementation
-    probabilitySeed, // Number between 1 and 100 (inclusive)
-    portalMap // PortalMap mapping between PortalType and portal base url
-);
-```
-
-A PortalMap example: 
-```typescript
-    const portalMap = new Map<PortalType, string>()
-        .set(PortalType.MASTER, 'https://42069.mastersportal.fyi')
-        .set(PortalType.PHD, 'https://42069.phdportal.fyi')
-        .set(PortalType.BACHELOR, 'https://42069.bachelorsportal.fyi')
-        .set(PortalType.SHORT, 'https://42069.shortcoursesportal.fyi')
-        .set(PortalType.DISTANCE_LEARNING, 'https://42069.distancelearningportal.fyi')
-```
-
-Fetch your model using the `fetch()` method with the requested ID (_in this 
-example programme ID_):
-```typescript
-const card: IProgrammeCard = await client.fetch(5);
-```
-Or get multiple using `fetchMultiple()` with the requested IDs (_in this example 
-programme IDs_):
-```typescript
-const cards: IProgrammeCard[] = await client.fetchMultiple([5, 9, 13]);
-```
-Some functions are accompanied by a `canShow` function that indicates its 
-availability. If the value is not set the function will throw a 
-`PropertyNotAvailableException`:
-
-```typescript
-const card: IProgrammeCard = await client.fetch(5);
-
-// Might throw PropertyNotAvailableException
-const cover: ICover = card.getCover();
-
-// Safe behaviour
-if (card.canShowCover()) {
-    const cover: ICover = card.getCover();
-}
-```
-
-## Separated usage
-
-In some cases you might want to separate the fetching of the information from 
-the usage of that information; for instance getting the information in your 
-back-end service and passing it to the front-end application for usage.
-
-First instantiate your client class with all parameters:
-```typescript
-const client = new ProgrammeCardClient(
-    domainApiUrl, // The url to the Domain API endpoint
-    apiKey, // The API key provided by PLOP for your implementation
-    probabilitySeed // Number between 1 and 100 (inclusive)
-);
-```
-To do this you can use the `fetchDescription()` method instead and encode it as 
-JSON:  
-```typescript
-const card: IModelDescription = await client.fetchDescription(5);
-const jsonData: string = JSON.stringify(card);
-```
-Or use the `fetchMultipleDescriptions()` function to fetch multiple descriptions:
-```typescript
-const cards: IModelDescription[] = await client.fetchMultipleDescriptions([5, 9, 13]);
-const jsonData: string = JSON.stringify(cards);
-```
-
-When you're ready to use the information in the models you can use the existing 
-client or instantiate a new one without parameters:
-```typescript
-const client = new ProgrammeCardClient();
-```
-After which you can use the `fromDescription()` and `fromDescriptions()` 
-functions to retrieve your models:
-```typescript
-const descriptions: IModelDescription[] = JSON.parse(jsonData);
-const card: IProgrammeCard = client.fromDescription(descriptions[0]);
-const cards: IProgrammeCard[] = client.fromDescriptions(descriptions);
-```
-Note that creating a client without providing the required parameters will 
-result in all network functionalities of the client being unavailable. In this 
-case the following functions will throw a `ClientException`: 
-```typescript
-await client.fetch(1);
-await client.fetchMultiple([5, 9, 13]);
-await client.fetchDescription(1);
-await client.fetchMultipleDescriptions([5, 9, 13]);
-```