@studyportals/domain-client 3.18.0 → 3.20.0

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

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

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

@@ -1,12 +1,12 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PortalType = void 0;
-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 = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PortalType = void 0;
+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

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

@@ -1,4 +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;
+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;

package/{bin/src → src}/types.js

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

package/.eslintignore

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

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/.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]);
-```

package/bin/package.json

@@ -1,55 +0,0 @@
-{
-  "name": "@studyportals/domain-client",
-  "version": "3.18.0",
-  "description": "Responsible for fetching data from the Domain API",
-  "main": "bin/index.js",
-  "author": "StudyPortals B.V.",
-  "contributors": [
-    "braaibander <danny@studyportals.com>"
-  ],
-  "license": "BSD-3-Clause",
-  "scripts": {
-    "test": "mocha --reporter spec \"tests/**/*.test.ts\"",
-    "coverage": "nyc mocha --reporter dot \"tests/**/*.test.ts\"",
-    "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": {
-    "axios": "^0.21.0"
-  },
-  "devDependencies": {
-    "@studyportals/code-style": "^1.8.1",
-    "@testdeck/mocha": "^0.3.3",
-    "@types/axios": "^0.14.0",
-    "@types/mocha": "^10.0.0",
-    "@types/moxios": "^0.4.9",
-    "@types/node": "^14.14.8",
-    "@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",
-    "mocha": "^10.1.0",
-    "moxios": "^0.4.0",
-    "nyc": "^15.1.0",
-    "source-map-support": "^0.5.19",
-    "ts-node": "^10.9.1",
-    "tslint": "^6.1.3",
-    "typemoq": "^2.1.0",
-    "typescript": "^4.9.3"
-  }
-}

package/index.ts

@@ -1,147 +0,0 @@
-import { BadRequestException } from "./src/exceptions/bad-request-exception"
-import { ClientException } from "./src/exceptions/client-exception"
-import { InternalServerException } from "./src/exceptions/internal-server-exception"
-import { NotFoundException } from "./src/exceptions/not-found-exception"
-import { PropertyNotAvailableException } from "./src/exceptions/property-not-available-exception"
-import { ICover } from "./src/models/programme-card/i-cover";
-import { ILink } from "./src/models/programme-card/i-link";
-import { IOptionalLink } from "./src/models/programme-card/i-optional-link";
-import { ILocation } from "./src/models/programme-card/i-location";
-import { IClickTrackingData } from "./src/models/programme-card/i-click-tracking-data";
-import { ITracking } from "./src/models/programme-card/i-tracking";
-import { IDuration } from "./src/models/programme-card/i-duration";
-import { IDeadline } from "./src/models/programme-card/i-deadline";
-import { IStartDate } from "./src/models/programme-card/i-start-date";
-import { ITiming } from "./src/models/programme-card/i-timing";
-import { ITrackedLink } from "./src/models/programme-card/i-tracked-link";
-import { IProgrammeCard } from "./src/models/programme-card/i-programme-card";
-import { ProgrammeCardClient } from "./src/models/programme-card/programme-card-client";
-import { ITuitionValues } from "./src/models/search-projection/i-tuition-values";
-import { IPremiumValues } from "./src/models/search-projection/i-premium-values";
-import { IOrganisationValues } from "./src/models/search-projection/i-organisation-values";
-import { IGeoTargetingConfiguration } from "./src/models/search-projection/i-geo-targeting-configuration";
-import { IGeoTargetingValues } from "./src/models/search-projection/i-geo-targeting-values";
-import { ISearchProjection } from "./src/models/search-projection/i-search-projection";
-import { SearchProjectionClient } from "./src/models/search-projection/search-projection-client";
-import { ILivingCost } from "./src/models/bestfit-programme/i-living-cost";
-import { IGPARequirement } from "./src/models/common/i-g-p-a-requirement";
-import { IBestFitProgramme } from "./src/models/bestfit-programme/i-best-fit-programme";
-import { BestfitProgrammeClient } from "./src/models/bestfit-programme/bestfit-programme-client";
-import { ILogo } from "./src/models/common/i-logo";
-import { ITuitionFee } from "./src/models/common/i-tuition-fee";
-import { IEnglishRequirements } from "./src/models/common/i-english-requirements";
-import { IInternalLink } from "./src/models/dotdigital-programme/i-internal-link";
-import { IDotDigitalProgramme } from "./src/models/dotdigital-programme/i-dot-digital-programme";
-import { DotdigitalProgrammeClient } from "./src/models/dotdigital-programme/dotdigital-programme-client";
-import { ISitemapProgrammeInfo } from "./src/models/sitemap-programme-info/i-sitemap-programme-info";
-import { SitemapProgrammeInfoClient } from "./src/models/sitemap-programme-info/sitemap-programme-info-client";
-import { ISearchCountryFaq } from "./src/models/search-country-faq/i-search-country-faq";
-import { PublicSearchCountryFaqClient } from "./src/models/search-country-faq/public-search-country-faq-client";
-import { ISitemapCountryInfo } from "./src/models/sitemap-countries-info/i-sitemap-country-info";
-import { SitemapCountriesInfoClient } from "./src/models/sitemap-countries-info/sitemap-countries-info-client";
-import { IDegreeInfo } from "./src/models/sitemap-country-degree-info/i-degree-info";
-import { ISitemapCountryDegreeInfo } from "./src/models/sitemap-country-degree-info/i-sitemap-country-degree-info";
-import { SitemapCountryDegreeInfoClient } from "./src/models/sitemap-country-degree-info/sitemap-country-degree-info-client";
-import { ISearchDiscipline } from "./src/models/search-discipline/i-search-discipline";
-import { PublicSearchDisciplineClient } from "./src/models/search-discipline/public-search-discipline-client";
-import { ISitemapDisciplineInfo } from "./src/models/sitemap-disciplines-info/i-sitemap-discipline-info";
-import { SitemapDisciplinesInfoClient } from "./src/models/sitemap-disciplines-info/sitemap-disciplines-info-client";
-import { ICountry } from "./src/models/common/i-country";
-import { ICity } from "./src/models/common/i-city";
-import { IReview } from "./src/models/dotdigital-organisation/i-review";
-import { IDotDigitalOrganisation } from "./src/models/dotdigital-organisation/i-dot-digital-organisation";
-import { DotdigitalOrganisationClient } from "./src/models/dotdigital-organisation/dotdigital-organisation-client";
-import { ISitemapOrganisationInfo } from "./src/models/sitemap-organisations-info/i-sitemap-organisation-info";
-import { SitemapOrganisationsInfoClient } from "./src/models/sitemap-organisations-info/sitemap-organisations-info-client";
-import { ISitemapRankingsInfo } from "./src/models/sitemap-rankings-info/i-sitemap-rankings-info";
-import { SitemapRankingsInfoClient } from "./src/models/sitemap-rankings-info/sitemap-rankings-info-client";
-import { ISitemapArticleInfo } from "./src/models/sitemap-articles-info/i-sitemap-article-info";
-import { SitemapArticlesInfoClient } from "./src/models/sitemap-articles-info/sitemap-articles-info-client";
-import { ISitemapCityInfo } from "./src/models/sitemap-cities-info/i-sitemap-city-info";
-import { SitemapCitiesInfoClient } from "./src/models/sitemap-cities-info/sitemap-cities-info-client";
-import { IScholarshipCard } from "./src/models/scholarship-card/i-scholarship-card";
-import { PublicScholarshipCardClient } from "./src/models/scholarship-card/public-scholarship-card-client";
-import { IRankingCards } from './src/models/ranking-cards/i-ranking-cards';
-import { IRankingCard } from './src/models/ranking-cards/i-ranking-card';
-import { IRanking } from './src/models/ranking-cards/i-ranking';
-import { PublicRankingCardsClient } from './src/models/ranking-cards/public-ranking-cards-client';
-import { PortalType } from "./src/types/portal-type";
-import { PortalMap } from "./src/types/portal-map";
-import { ModelClient } from "./src/model-client";
-import { ICompareProgramme } from "./src/models/compare-programme/i-compare-programme"
-import { CompareProgrammeClient } from "./src/models/compare-programme/compare-programme-client"
-
-export {
-	BadRequestException,
-	ClientException,
-	InternalServerException,
-	NotFoundException,
-	PropertyNotAvailableException,
-	ICover,
-	ILink,
-	IOptionalLink,
-	ILocation,
-	IClickTrackingData,
-	ITracking,
-	IDuration,
-	IDeadline,
-	IStartDate,
-	ITiming,
-	ITrackedLink,
-	IProgrammeCard,
-	ProgrammeCardClient,
-	ITuitionValues,
-	IPremiumValues,
-	IOrganisationValues,
-	IGeoTargetingConfiguration,
-	IGeoTargetingValues,
-	ISearchProjection,
-	SearchProjectionClient,
-	ILivingCost,
-	IGPARequirement,
-	IBestFitProgramme,
-	BestfitProgrammeClient,
-	ILogo,
-	ITuitionFee,
-	IEnglishRequirements,
-	IInternalLink,
-	IDotDigitalProgramme,
-	DotdigitalProgrammeClient,
-	ISitemapProgrammeInfo,
-	SitemapProgrammeInfoClient,
-	ISearchCountryFaq,
-	PublicSearchCountryFaqClient,
-	ISitemapCountryInfo,
-	SitemapCountriesInfoClient,
-	IDegreeInfo,
-	ISitemapCountryDegreeInfo,
-	SitemapCountryDegreeInfoClient,
-	ISearchDiscipline,
-	PublicSearchDisciplineClient,
-	ISitemapDisciplineInfo,
-	SitemapDisciplinesInfoClient,
-	ICountry,
-	ICity,
-	IReview,
-	IDotDigitalOrganisation,
-	DotdigitalOrganisationClient,
-	ISitemapOrganisationInfo,
-	SitemapOrganisationsInfoClient,
-	ISitemapRankingsInfo,
-	SitemapRankingsInfoClient,
-	ISitemapArticleInfo,
-	SitemapArticlesInfoClient,
-	ISitemapCityInfo,
-	SitemapCitiesInfoClient,
-	IScholarshipCard,
-	PublicScholarshipCardClient,
-	IRankingCards,
-	IRankingCard,
-	IRanking,
-	PublicRankingCardsClient,
-	ICompareProgramme,
-	CompareProgrammeClient,
-	PortalType,
-	PortalMap,
-	ModelClient
-}

package/src/domain-client.ts

@@ -1,70 +0,0 @@
-import Axios, { AxiosRequestConfig } from "axios";
-
-import { BadRequestException } from "./exceptions/bad-request-exception";
-import { InternalServerException } from "./exceptions/internal-server-exception";
-import { NotFoundException } from "./exceptions/not-found-exception";
-import { IApiResponse } from "./i-api-response";
-import { IModelDescription } from "./i-model-description";
-
-
-export class DomainClient {
-
-	constructor(
-		public readonly baseUrl: string,
-		public readonly apiKey: string | undefined,
-		public readonly model: string,
-		public readonly version: string,
-		public readonly isPublic: boolean,
-		public readonly seed: number
-	) {
-	}
-
-	public async doRequest(ids: number[]): Promise<IModelDescription[]> {
-		const url = this.buildUrl(ids);
-		const config: AxiosRequestConfig = { baseURL: this.baseUrl	}
-		if (this.apiKey !== undefined) {
-			// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-			config["headers"] = {'x-api-key': this.apiKey}
-		}
-		const axiosResponse = await Axios.get(url, config);
-		const response = axiosResponse.data as IApiResponse;
-		this.handleErrors(response);
-
-		const models: IModelDescription[] = [];
-		for (const id of ids) {
-			const modelData = response.data[id];
-			if (!modelData) {
-				continue;
-			}
-			models.push(modelData);
-		}
-		return models;
-	}
-
-	private handleErrors(response: IApiResponse): void {
-		if (!response.status) {
-			throw new InternalServerException(response.message);
-		}
-
-		if (response.status === 400) {
-			throw new BadRequestException(response.message);
-		}
-
-		if (response.status === 404) {
-			throw new NotFoundException(response.message);
-		}
-	}
-
-	private buildUrl(ids: number[]): string {
-		const publicPrefix = this.shouldAddPublicPrefix() ? 'public/' : '';
-		let query = `${publicPrefix}${this.model}/${this.version}/?seed=${this.seed}`;
-		for (const id of ids) {
-			query += `&id=${id}`;
-		}
-		return query;
-	}
-
-	private shouldAddPublicPrefix(): boolean {
-		return this.isPublic && this.apiKey === undefined;
-	}
-}

package/src/exceptions/bad-request-exception.ts

@@ -1,2 +0,0 @@
-export class BadRequestException extends Error {
-}

package/src/exceptions/client-exception.ts

@@ -1,2 +0,0 @@
-export class ClientException extends Error {
-}

package/src/exceptions/internal-server-exception.ts

@@ -1,2 +0,0 @@
-export class InternalServerException extends Error {
-}

package/src/exceptions/not-found-exception.ts

@@ -1,2 +0,0 @@
-export class NotFoundException extends Error {
-}

package/src/exceptions/property-not-available-exception.ts

@@ -1,2 +0,0 @@
-export class PropertyNotAvailableException extends Error {
-}

package/src/factories/DateFactory.ts

@@ -1,8 +0,0 @@
-import { IClassFactory } from "../i-class-factory";
-import { CallableReturnType, Model } from "../types";
-
-export class DateFactory implements IClassFactory {
-	public create(data: Model, parameters: string[]): CallableReturnType {
-		return new Date(parameters[0]);
-	}
-}

package/src/factories/InternalLinkFactory.ts

@@ -1,27 +0,0 @@
-import { IClassFactory } from "../i-class-factory";
-import { PortalType } from "../types/portal-type";
-import { CallableReturnType, Model } from "../types";
-import { PortalMap } from "../types/portal-map";
-
-export class InternalLinkFactory implements IClassFactory {
-	private portalMap: PortalMap;
-
-	constructor(portalMap: PortalMap) {
-		this.portalMap = portalMap;
-	}
-
-	public create(link: Model): CallableReturnType {
-		const portalBaseUrl = this.getPortalBaseUrl(link.getPortalType() as PortalType);
-
-		const path = link['getUrl']() as string;
-		link['getUrl'] = (): string => portalBaseUrl + path;
-
-		return link;
-	}
-
-	private getPortalBaseUrl(portalType: PortalType): string {
-		const url = this.portalMap.get(portalType);
-		return url || '';
-	}
-
-}

package/src/i-api-response.ts

@@ -1,7 +0,0 @@
-import { IModelDescription } from "./i-model-description";
-
-export interface IApiResponse {
-	status: number;
-	data: Record<number, IModelDescription>;
-	message: string
-}

package/src/i-class-factory.ts

@@ -1,5 +0,0 @@
-import { CallableReturnType, Model } from "./types";
-
-export interface IClassFactory {
-	create(data: Model, parameters?: any[]): CallableReturnType
-}

package/src/i-model-description.ts

@@ -1,13 +0,0 @@
-import { AcceptedType } from "./types";
-
-export interface IModelDescription {
-	class: string;
-	func: Record<string, AcceptedType | IModelDescription>;
-	parameters?: any[];
-}
-
-// eslint-disable-next-line
-export function isModelDescription(arg: any): arg is IModelDescription {
-	// eslint-disable-next-line
-	return arg && arg.class && (arg.func || arg.parameters);
-}