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

package/src/models/organisation-card/i-ranking-discipline.js

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

package/src/models/organisation-card/organisation-card-client.js

@@ -0,0 +1,12 @@
+import { ModelClient } from "../../model-client";
+export class OrganisationCardClient extends ModelClient {
+    getModelName() {
+        return 'organisation-card';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}

package/src/models/organisation-for-search/i-organisation-for-search.js

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

package/src/models/organisation-for-search/public-organisation-for-search-client.js

@@ -0,0 +1,12 @@
+import { ModelClient } from "../../model-client";
+export class PublicOrganisationForSearchClient extends ModelClient {
+    getModelName() {
+        return 'organisation-for-search';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return true;
+    }
+}

package/{bin/src → 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/organisation-search-document/i-organisation-search-document.js

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

package/src/models/organisation-search-document/organisation-search-document-client.js

@@ -0,0 +1,12 @@
+import { ModelClient } from "../../model-client";
+export class OrganisationSearchDocumentClient extends ModelClient {
+    getModelName() {
+        return 'organisation-search-document';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}

package/src/models/programme-card/i-click-tracking-data.js

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

package/src/models/programme-card/i-optional-link.js

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

package/{bin/src → src}/models/programme-card/i-programme-card.d.ts

@@ -1,4 +1,5 @@
 import { ICover, IDuration, IEnglishRequirements, IGPARequirement, IInternalLink, ILink, ILivingCost, ILocation, ILogo, ITiming, ITrackedLink, ITracking, ITuitionFee } from "../../..";
+import { IReviewRating } from "../common/i-review-rating";
 export interface IProgrammeCard {
     /**
      * ISO code of the country the programme is taught.
@@ -202,4 +203,10 @@ export interface IProgrammeCard {
      * @return number
      */
     getCampaignType(): number | null;
+    /**
+     * Get the review rating of the programme.
+     *
+     * @return IReviewRating | null
+     */
+    getReviewRating(): IReviewRating | null;
 }

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

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

package/src/models/programme-card/i-start-date.js

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,12 @@
+import { ModelClient } from "../../model-client";
+export class ProgrammeCardClient extends ModelClient {
+    getModelName() {
+        return 'programme-card';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}

package/src/models/ranking-cards/i-ranking.js

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

package/src/models/scholarship-card/i-scholarship-card-v2.d.ts

@@ -0,0 +1,20 @@
+export interface IScholarshipCardV2 {
+    getDescriptionOfApplicationBasis(): string | null;
+    getDescriptionOfBenefits(): string | null;
+    getDescriptionOfDeadline(): string;
+    getDescriptionOfDestinationCountryRestrictions(): string;
+    getDescriptionOfProviderLocation(): string | null;
+    getIsNotSpecifiedDeadline(): boolean;
+    getProviderId(): string | null;
+    getProviderIsUniversity(): boolean;
+    getProviderLogoSquareCdn(): string | null;
+    getProviderName(): string;
+    getScholarshipId(): string;
+    getScholarshipTitle(): string;
+    getScholarshipVirtualName(): string;
+    getDisciplineIds(): number[] | null;
+    getOriginCountryIds(): string[] | null;
+    getGrantCurrencyIso(): string | null;
+    getGrantAmount(): number | null;
+    getGrantDescription(): string | null;
+}

package/src/models/scholarship-card/i-scholarship-card-v2.js

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

package/src/models/scholarship-card/i-scholarship-card.js

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

package/src/models/scholarship-card/public-scholarship-card-client.js

@@ -0,0 +1,12 @@
+import { ModelClient } from "../../model-client";
+export class PublicScholarshipCardClient extends ModelClient {
+    getModelName() {
+        return 'scholarship-card';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return true;
+    }
+}

package/src/models/scholarship-card/scholarship-card-v2-client.js

@@ -0,0 +1,12 @@
+import { ModelClient } from "../../model-client";
+export class ScholarshipCardV2Client extends ModelClient {
+    getModelName() {
+        return 'scholarship-card-v2';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}

package/src/models/scholarship-search-document/i-scholarship-search-document.js

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

package/src/models/scholarship-search-document/scholarship-search-document-client.js

@@ -0,0 +1,12 @@
+import { ModelClient } from "../../model-client";
+export class ScholarshipSearchDocumentClient extends ModelClient {
+    getModelName() {
+        return 'scholarship-search-document';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}

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

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

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

@@ -0,0 +1,12 @@
+import { ModelClient } from "../../model-client";
+export class PublicSearchDisciplineClient extends ModelClient {
+    getModelName() {
+        return 'search-discipline';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return true;
+    }
+}

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

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

package/src/models/search-projection/i-geo-targeting-values.js

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

package/src/models/search-projection/i-organisation-values.js

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

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

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

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

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

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

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

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

@@ -0,0 +1,12 @@
+import { ModelClient } from "../../model-client";
+export class SearchProjectionClient extends ModelClient {
+    getModelName() {
+        return 'search-projection';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}

package/src/models/sitemap-articles-info/i-sitemap-article-info.js

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

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

@@ -0,0 +1,12 @@
+import { ModelClient } from "../../model-client";
+export class SitemapArticlesInfoClient extends ModelClient {
+    getModelName() {
+        return 'sitemap-articles-info';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}

package/src/models/sitemap-cities-info/i-sitemap-city-info.js

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

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

@@ -0,0 +1,12 @@
+import { ModelClient } from "../../model-client";
+export class SitemapCitiesInfoClient extends ModelClient {
+    getModelName() {
+        return 'sitemap-cities-info';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}

package/src/models/sitemap-countries-info/i-sitemap-country-info.js

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

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

@@ -0,0 +1,12 @@
+import { ModelClient } from "../../model-client";
+export class SitemapCountriesInfoClient extends ModelClient {
+    getModelName() {
+        return 'sitemap-countries-info';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}

package/src/models/sitemap-country-degree-info/i-degree-info.js

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

package/src/models/sitemap-country-degree-info/i-sitemap-country-degree-info.js

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

package/src/models/sitemap-country-degree-info/sitemap-country-degree-info-client.js

@@ -0,0 +1,12 @@
+import { ModelClient } from "../../model-client";
+export class SitemapCountryDegreeInfoClient extends ModelClient {
+    getModelName() {
+        return 'sitemap-country-degree-info';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}

package/src/models/sitemap-disciplines-info/i-sitemap-discipline-info.js

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

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

@@ -0,0 +1,12 @@
+import { ModelClient } from "../../model-client";
+export class SitemapDisciplinesInfoClient extends ModelClient {
+    getModelName() {
+        return 'sitemap-disciplines-info';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}

package/src/models/sitemap-organisations-info/i-sitemap-organisation-info.js

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

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

@@ -0,0 +1,12 @@
+import { ModelClient } from "../../model-client";
+export class SitemapOrganisationsInfoClient extends ModelClient {
+    getModelName() {
+        return 'sitemap-organisations-info';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}

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

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

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

@@ -0,0 +1,12 @@
+import { ModelClient } from "../../model-client";
+export class SitemapProgrammeInfoClient extends ModelClient {
+    getModelName() {
+        return 'sitemap-programme-info';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}

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

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

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

@@ -0,0 +1,12 @@
+import { ModelClient } from "../../model-client";
+export class SitemapRankingsInfoClient extends ModelClient {
+    getModelName() {
+        return 'sitemap-rankings-info';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}

package/src/types/portal-map.js

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

package/{bin/src → src}/types/portal-type.js

@@ -1,12 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PortalType = void 0;
-var PortalType;
+export var PortalType;
 (function (PortalType) {
     PortalType["MASTER"] = "master";
     PortalType["BACHELOR"] = "bachelor";
     PortalType["PHD"] = "phd";
     PortalType["SHORT"] = "short";
     PortalType["DISTANCE_LEARNING"] = "distance_learning";
-})(PortalType = exports.PortalType || (exports.PortalType = {}));
-//# sourceMappingURL=portal-type.js.map
+})(PortalType || (PortalType = {}));

package/src/types.js

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

package/.eslintignore

@@ -1,4 +0,0 @@
-**/node_modules/*
-**/bin/*
-**/tests/*/
-/coverage

package/.eslintrc.js

@@ -1,13 +0,0 @@
-module.exports = {
-    root: true,
-    env: {
-        node: true
-    },
-    rules: {
-        "no-shadow": "off",
-        "max-len": "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/.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]);
-```