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

package/.eslintignore

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

package/.eslintrc.js

@@ -0,0 +1,13 @@
+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

@@ -0,0 +1,17 @@
+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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,15 @@
+{
+  "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

@@ -0,0 +1,117 @@
+# 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/index.d.ts

@@ -0,0 +1,81 @@
+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/customerio-programme/i-internal-link";
+import { ICustomerIOProgramme } from "./src/models/customerio-programme/i-customer-io-programme";
+import { CustomerIOProgrammeClient } from "./src/models/customerio-programme/customerio-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 { 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/customerio-organisation/i-review";
+import { ICustomerIOOrganisation } from "./src/models/customerio-organisation/i-customer-io-organisation";
+import { CustomerIOOrganisationClient } from "./src/models/customerio-organisation/customerio-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 { IOrganisationCard } from "./src/models/organisation-card/i-organisation-card";
+import { IRankingDiscipline } from "./src/models/organisation-card/i-ranking-discipline";
+import { OrganisationCardClient } from "./src/models/organisation-card/organisation-card-client";
+import { IOrganisationSearchDocument } from "./src/models/organisation-search-document/i-organisation-search-document";
+import { OrganisationSearchDocumentClient } from "./src/models/organisation-search-document/organisation-search-document-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 { ScholarshipCardV2Client } from "./src/models/scholarship-card/scholarship-card-v2-client";
+import { IScholarshipSearchDocument } from "./src/models/scholarship-search-document/i-scholarship-search-document";
+import { ScholarshipSearchDocumentClient } from "./src/models/scholarship-search-document/scholarship-search-document-client";
+import { IRanking } from './src/models/ranking-cards/i-ranking';
+import { PortalType } from "./src/types/portal-type";
+import { PortalMap } from "./src/types/portal-map";
+import { ModelClient } from "./src/model-client";
+import { IOrganisationForSearch } from "./src/models/organisation-for-search/i-organisation-for-search";
+import { PublicOrganisationForSearchClient } from "./src/models/organisation-for-search/public-organisation-for-search-client";
+import { ICopilotProgramme } from "./src/models/copilot-programme/i-copilot-programme";
+import { CopilotProgrammeClient } from "./src/models/copilot-programme/copilot-programme-client";
+import { ICopilotCountry } from "./src/models/copilot-country/i-copilot-country";
+import { CopilotCountryClient } from "./src/models/copilot-country/copilot-country-client";
+import { ICopilotRankingCard } from "./src/models/copilot-country/i-copilot-ranking-card";
+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, ICustomerIOProgramme, CustomerIOProgrammeClient, ISitemapProgrammeInfo, SitemapProgrammeInfoClient, ISitemapCountryInfo, SitemapCountriesInfoClient, IDegreeInfo, ISitemapCountryDegreeInfo, SitemapCountryDegreeInfoClient, ISearchDiscipline, PublicSearchDisciplineClient, ISitemapDisciplineInfo, SitemapDisciplinesInfoClient, ICountry, ICity, IReview, ICustomerIOOrganisation, CustomerIOOrganisationClient, ISitemapOrganisationInfo, SitemapOrganisationsInfoClient, IOrganisationSearchDocument, OrganisationSearchDocumentClient, ISitemapRankingsInfo, SitemapRankingsInfoClient, ISitemapArticleInfo, SitemapArticlesInfoClient, ISitemapCityInfo, SitemapCitiesInfoClient, IScholarshipCard, PublicScholarshipCardClient, ScholarshipCardV2Client, IScholarshipSearchDocument, ScholarshipSearchDocumentClient, IRanking, PortalType, PortalMap, ModelClient, IOrganisationForSearch, PublicOrganisationForSearchClient, IOrganisationCard, IRankingDiscipline, OrganisationCardClient, ICopilotProgramme, ICopilotCountry, CopilotProgrammeClient, CopilotCountryClient, ICopilotRankingCard };

package/bin/index.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CopilotCountryClient = exports.CopilotProgrammeClient = exports.OrganisationCardClient = exports.PublicOrganisationForSearchClient = exports.ModelClient = exports.PortalType = exports.ScholarshipSearchDocumentClient = exports.ScholarshipCardV2Client = exports.PublicScholarshipCardClient = exports.SitemapCitiesInfoClient = exports.SitemapArticlesInfoClient = exports.SitemapRankingsInfoClient = exports.OrganisationSearchDocumentClient = exports.SitemapOrganisationsInfoClient = exports.CustomerIOOrganisationClient = exports.SitemapDisciplinesInfoClient = exports.PublicSearchDisciplineClient = exports.SitemapCountryDegreeInfoClient = exports.SitemapCountriesInfoClient = exports.SitemapProgrammeInfoClient = exports.CustomerIOProgrammeClient = exports.BestfitProgrammeClient = exports.SearchProjectionClient = exports.ProgrammeCardClient = exports.PropertyNotAvailableException = exports.NotFoundException = exports.InternalServerException = exports.ClientException = exports.BadRequestException = void 0;
+const bad_request_exception_1 = require("./src/exceptions/bad-request-exception");
+Object.defineProperty(exports, "BadRequestException", { enumerable: true, get: function () { return bad_request_exception_1.BadRequestException; } });
+const client_exception_1 = require("./src/exceptions/client-exception");
+Object.defineProperty(exports, "ClientException", { enumerable: true, get: function () { return client_exception_1.ClientException; } });
+const internal_server_exception_1 = require("./src/exceptions/internal-server-exception");
+Object.defineProperty(exports, "InternalServerException", { enumerable: true, get: function () { return internal_server_exception_1.InternalServerException; } });
+const not_found_exception_1 = require("./src/exceptions/not-found-exception");
+Object.defineProperty(exports, "NotFoundException", { enumerable: true, get: function () { return not_found_exception_1.NotFoundException; } });
+const property_not_available_exception_1 = require("./src/exceptions/property-not-available-exception");
+Object.defineProperty(exports, "PropertyNotAvailableException", { enumerable: true, get: function () { return property_not_available_exception_1.PropertyNotAvailableException; } });
+const programme_card_client_1 = require("./src/models/programme-card/programme-card-client");
+Object.defineProperty(exports, "ProgrammeCardClient", { enumerable: true, get: function () { return programme_card_client_1.ProgrammeCardClient; } });
+const search_projection_client_1 = require("./src/models/search-projection/search-projection-client");
+Object.defineProperty(exports, "SearchProjectionClient", { enumerable: true, get: function () { return search_projection_client_1.SearchProjectionClient; } });
+const bestfit_programme_client_1 = require("./src/models/bestfit-programme/bestfit-programme-client");
+Object.defineProperty(exports, "BestfitProgrammeClient", { enumerable: true, get: function () { return bestfit_programme_client_1.BestfitProgrammeClient; } });
+const customerio_programme_client_1 = require("./src/models/customerio-programme/customerio-programme-client");
+Object.defineProperty(exports, "CustomerIOProgrammeClient", { enumerable: true, get: function () { return customerio_programme_client_1.CustomerIOProgrammeClient; } });
+const sitemap_programme_info_client_1 = require("./src/models/sitemap-programme-info/sitemap-programme-info-client");
+Object.defineProperty(exports, "SitemapProgrammeInfoClient", { enumerable: true, get: function () { return sitemap_programme_info_client_1.SitemapProgrammeInfoClient; } });
+const sitemap_countries_info_client_1 = require("./src/models/sitemap-countries-info/sitemap-countries-info-client");
+Object.defineProperty(exports, "SitemapCountriesInfoClient", { enumerable: true, get: function () { return sitemap_countries_info_client_1.SitemapCountriesInfoClient; } });
+const sitemap_country_degree_info_client_1 = require("./src/models/sitemap-country-degree-info/sitemap-country-degree-info-client");
+Object.defineProperty(exports, "SitemapCountryDegreeInfoClient", { enumerable: true, get: function () { return sitemap_country_degree_info_client_1.SitemapCountryDegreeInfoClient; } });
+const public_search_discipline_client_1 = require("./src/models/search-discipline/public-search-discipline-client");
+Object.defineProperty(exports, "PublicSearchDisciplineClient", { enumerable: true, get: function () { return public_search_discipline_client_1.PublicSearchDisciplineClient; } });
+const sitemap_disciplines_info_client_1 = require("./src/models/sitemap-disciplines-info/sitemap-disciplines-info-client");
+Object.defineProperty(exports, "SitemapDisciplinesInfoClient", { enumerable: true, get: function () { return sitemap_disciplines_info_client_1.SitemapDisciplinesInfoClient; } });
+const customerio_organisation_client_1 = require("./src/models/customerio-organisation/customerio-organisation-client");
+Object.defineProperty(exports, "CustomerIOOrganisationClient", { enumerable: true, get: function () { return customerio_organisation_client_1.CustomerIOOrganisationClient; } });
+const sitemap_organisations_info_client_1 = require("./src/models/sitemap-organisations-info/sitemap-organisations-info-client");
+Object.defineProperty(exports, "SitemapOrganisationsInfoClient", { enumerable: true, get: function () { return sitemap_organisations_info_client_1.SitemapOrganisationsInfoClient; } });
+const organisation_card_client_1 = require("./src/models/organisation-card/organisation-card-client");
+Object.defineProperty(exports, "OrganisationCardClient", { enumerable: true, get: function () { return organisation_card_client_1.OrganisationCardClient; } });
+const organisation_search_document_client_1 = require("./src/models/organisation-search-document/organisation-search-document-client");
+Object.defineProperty(exports, "OrganisationSearchDocumentClient", { enumerable: true, get: function () { return organisation_search_document_client_1.OrganisationSearchDocumentClient; } });
+const sitemap_rankings_info_client_1 = require("./src/models/sitemap-rankings-info/sitemap-rankings-info-client");
+Object.defineProperty(exports, "SitemapRankingsInfoClient", { enumerable: true, get: function () { return sitemap_rankings_info_client_1.SitemapRankingsInfoClient; } });
+const sitemap_articles_info_client_1 = require("./src/models/sitemap-articles-info/sitemap-articles-info-client");
+Object.defineProperty(exports, "SitemapArticlesInfoClient", { enumerable: true, get: function () { return sitemap_articles_info_client_1.SitemapArticlesInfoClient; } });
+const sitemap_cities_info_client_1 = require("./src/models/sitemap-cities-info/sitemap-cities-info-client");
+Object.defineProperty(exports, "SitemapCitiesInfoClient", { enumerable: true, get: function () { return sitemap_cities_info_client_1.SitemapCitiesInfoClient; } });
+const public_scholarship_card_client_1 = require("./src/models/scholarship-card/public-scholarship-card-client");
+Object.defineProperty(exports, "PublicScholarshipCardClient", { enumerable: true, get: function () { return public_scholarship_card_client_1.PublicScholarshipCardClient; } });
+const scholarship_card_v2_client_1 = require("./src/models/scholarship-card/scholarship-card-v2-client");
+Object.defineProperty(exports, "ScholarshipCardV2Client", { enumerable: true, get: function () { return scholarship_card_v2_client_1.ScholarshipCardV2Client; } });
+const scholarship_search_document_client_1 = require("./src/models/scholarship-search-document/scholarship-search-document-client");
+Object.defineProperty(exports, "ScholarshipSearchDocumentClient", { enumerable: true, get: function () { return scholarship_search_document_client_1.ScholarshipSearchDocumentClient; } });
+const portal_type_1 = require("./src/types/portal-type");
+Object.defineProperty(exports, "PortalType", { enumerable: true, get: function () { return portal_type_1.PortalType; } });
+const model_client_1 = require("./src/model-client");
+Object.defineProperty(exports, "ModelClient", { enumerable: true, get: function () { return model_client_1.ModelClient; } });
+const public_organisation_for_search_client_1 = require("./src/models/organisation-for-search/public-organisation-for-search-client");
+Object.defineProperty(exports, "PublicOrganisationForSearchClient", { enumerable: true, get: function () { return public_organisation_for_search_client_1.PublicOrganisationForSearchClient; } });
+const copilot_programme_client_1 = require("./src/models/copilot-programme/copilot-programme-client");
+Object.defineProperty(exports, "CopilotProgrammeClient", { enumerable: true, get: function () { return copilot_programme_client_1.CopilotProgrammeClient; } });
+const copilot_country_client_1 = require("./src/models/copilot-country/copilot-country-client");
+Object.defineProperty(exports, "CopilotCountryClient", { enumerable: true, get: function () { return copilot_country_client_1.CopilotCountryClient; } });
+//# sourceMappingURL=index.js.map

package/bin/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,kFAA6E;AAkF5E,oGAlFQ,2CAAmB,OAkFR;AAjFpB,wEAAoE;AAkFnE,gGAlFQ,kCAAe,OAkFR;AAjFhB,0FAAqF;AAkFpF,wGAlFQ,mDAAuB,OAkFR;AAjFxB,8EAAyE;AAkFxE,kGAlFQ,uCAAiB,OAkFR;AAjFlB,wGAAkG;AAkFjG,8GAlFQ,gEAA6B,OAkFR;AArE9B,6FAAwF;AAkFvF,oGAlFQ,2CAAmB,OAkFR;AA3EpB,sGAAiG;AAkFhG,uGAlFQ,iDAAsB,OAkFR;AA9EvB,sGAAiG;AAkFhG,uGAlFQ,iDAAsB,OAkFR;AA5EvB,+GAA0G;AAkFzG,0GAlFQ,uDAAyB,OAkFR;AAhF1B,qHAA+G;AAkF9G,2GAlFQ,0DAA0B,OAkFR;AAhF3B,qHAA+G;AAkF9G,2GAlFQ,0DAA0B,OAkFR;AA/E3B,oIAA6H;AAkF5H,+GAlFQ,mEAA8B,OAkFR;AAhF/B,oHAA8G;AAkF7G,6GAlFQ,8DAA4B,OAkFR;AAhF7B,2HAAqH;AAkFpH,6GAlFQ,8DAA4B,OAkFR;AA7E7B,wHAAmH;AAkFlH,6GAlFQ,6DAA4B,OAkFR;AAhF7B,iIAA2H;AAkF1H,+GAlFQ,kEAA8B,OAkFR;AA/E/B,sGAAiG;AAqGhG,uGArGQ,iDAAsB,OAqGR;AAnGvB,uIAAiI;AA+EhI,iHA/EQ,sEAAgC,OA+ER;AA7EjC,kHAA4G;AA+E3G,0GA/EQ,wDAAyB,OA+ER;AA7E1B,kHAA4G;AA+E3G,0GA/EQ,wDAAyB,OA+ER;AA7E1B,4GAAsG;AA+ErG,wGA/EQ,oDAAuB,OA+ER;AA7ExB,iHAA2G;AA+E1G,4GA/EQ,4DAA2B,OA+ER;AA9E5B,yGAAmG;AA+ElG,wGA/EQ,oDAAuB,OA+ER;AA7ExB,oIAA8H;AA+E7H,gHA/EQ,oEAA+B,OA+ER;AA7EhC,yDAAqD;AA+EpD,2FA/EQ,wBAAU,OA+ER;AA7EX,qDAAiD;AA+EhD,4FA/EQ,0BAAW,OA+ER;AA7EZ,sIAA+H;AA+E9H,kHA/EQ,yEAAiC,OA+ER;AA7ElC,sGAAiG;AAmFhG,uGAnFQ,iDAAsB,OAmFR;AAjFvB,gGAA2F;AAkF1F,qGAlFQ,6CAAoB,OAkFR"}

package/bin/package.json

@@ -0,0 +1,55 @@
+{
+	"name": "@studyportals/domain-client",
+	"version": "5.4.4",
+	"description": "Responsible for fetching data from the Domain API",
+	"main": "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": "^1.6.0"
+	},
+	"devDependencies": {
+		"@studyportals/code-style": "^2.0.4",
+		"@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/bin/src/domain-client.d.ts

@@ -0,0 +1,14 @@
+import { IModelDescription } from "./i-model-description";
+export declare class DomainClient {
+    readonly baseUrl: string;
+    readonly apiKey: string | undefined;
+    readonly model: string;
+    readonly version: string;
+    readonly isPublic: boolean;
+    readonly seed: number;
+    constructor(baseUrl: string, apiKey: string | undefined, model: string, version: string, isPublic: boolean, seed: number);
+    doRequest(ids: number[]): Promise<IModelDescription[]>;
+    private handleErrors;
+    private buildUrl;
+    private shouldAddPublicPrefix;
+}

package/bin/src/domain-client.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DomainClient = void 0;
+const axios_1 = require("axios");
+const bad_request_exception_1 = require("./exceptions/bad-request-exception");
+const internal_server_exception_1 = require("./exceptions/internal-server-exception");
+const not_found_exception_1 = require("./exceptions/not-found-exception");
+class DomainClient {
+    constructor(baseUrl, apiKey, model, version, isPublic, seed) {
+        this.baseUrl = baseUrl;
+        this.apiKey = apiKey;
+        this.model = model;
+        this.version = version;
+        this.isPublic = isPublic;
+        this.seed = seed;
+    }
+    async doRequest(ids) {
+        const url = this.buildUrl(ids);
+        const config = { 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_1.default.get(url, config);
+        const response = axiosResponse.data;
+        this.handleErrors(response);
+        const models = [];
+        for (const id of ids) {
+            const modelData = response.data[id];
+            if (!modelData) {
+                continue;
+            }
+            models.push(modelData);
+        }
+        return models;
+    }
+    handleErrors(response) {
+        if (!response.status) {
+            throw new internal_server_exception_1.InternalServerException(response.message);
+        }
+        if (response.status === 400) {
+            throw new bad_request_exception_1.BadRequestException(response.message);
+        }
+        if (response.status === 404) {
+            throw new not_found_exception_1.NotFoundException(response.message);
+        }
+    }
+    buildUrl(ids) {
+        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;
+    }
+    shouldAddPublicPrefix() {
+        return this.isPublic && this.apiKey === undefined;
+    }
+}
+exports.DomainClient = DomainClient;
+//# sourceMappingURL=domain-client.js.map

package/bin/src/domain-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"domain-client.js","sourceRoot":"","sources":["../../src/domain-client.ts"],"names":[],"mappings":";;;AAAA,iCAAkD;AAElD,8EAAyE;AACzE,sFAAiF;AACjF,0EAAqE;AAKrE,MAAa,YAAY;IAExB,YACiB,OAAe,EACf,MAA0B,EAC1B,KAAa,EACb,OAAe,EACf,QAAiB,EACjB,IAAY;QALZ,YAAO,GAAP,OAAO,CAAQ;QACf,WAAM,GAAN,MAAM,CAAoB;QAC1B,UAAK,GAAL,KAAK,CAAQ;QACb,YAAO,GAAP,OAAO,CAAQ;QACf,aAAQ,GAAR,QAAQ,CAAS;QACjB,SAAI,GAAJ,IAAI,CAAQ;IAE7B,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,GAAa;QACnC,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC/B,MAAM,MAAM,GAAuB,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAA;QAC5D,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;YAC9B,sEAAsE;YACtE,MAAM,CAAC,SAAS,CAAC,GAAG,EAAC,WAAW,EAAE,IAAI,CAAC,MAAM,EAAC,CAAA;SAC9C;QACD,MAAM,aAAa,GAAG,MAAM,eAAK,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACnD,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAoB,CAAC;QACpD,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAE5B,MAAM,MAAM,GAAwB,EAAE,CAAC;QACvC,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE;YACrB,MAAM,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACpC,IAAI,CAAC,SAAS,EAAE;gBACf,SAAS;aACT;YACD,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SACvB;QACD,OAAO,MAAM,CAAC;IACf,CAAC;IAEO,YAAY,CAAC,QAAsB;QAC1C,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;YACrB,MAAM,IAAI,mDAAuB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;SACpD;QAED,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;YAC5B,MAAM,IAAI,2CAAmB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;SAChD;QAED,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;YAC5B,MAAM,IAAI,uCAAiB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;SAC9C;IACF,CAAC;IAEO,QAAQ,CAAC,GAAa;QAC7B,MAAM,YAAY,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;QACnE,IAAI,KAAK,GAAG,GAAG,YAAY,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,OAAO,UAAU,IAAI,CAAC,IAAI,EAAE,CAAC;QAC9E,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE;YACrB,KAAK,IAAI,OAAO,EAAE,EAAE,CAAC;SACrB;QACD,OAAO,KAAK,CAAC;IACd,CAAC;IAEO,qBAAqB;QAC5B,OAAO,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC;IACnD,CAAC;CACD;AA5DD,oCA4DC"}

package/bin/src/exceptions/bad-request-exception.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BadRequestException = void 0;
+class BadRequestException extends Error {
+}
+exports.BadRequestException = BadRequestException;
+//# sourceMappingURL=bad-request-exception.js.map

package/bin/src/exceptions/bad-request-exception.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bad-request-exception.js","sourceRoot":"","sources":["../../../src/exceptions/bad-request-exception.ts"],"names":[],"mappings":";;;AAAA,MAAa,mBAAoB,SAAQ,KAAK;CAC7C;AADD,kDACC"}

package/bin/src/exceptions/client-exception.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClientException = void 0;
+class ClientException extends Error {
+}
+exports.ClientException = ClientException;
+//# sourceMappingURL=client-exception.js.map

package/bin/src/exceptions/client-exception.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client-exception.js","sourceRoot":"","sources":["../../../src/exceptions/client-exception.ts"],"names":[],"mappings":";;;AAAA,MAAa,eAAgB,SAAQ,KAAK;CACzC;AADD,0CACC"}

package/bin/src/exceptions/internal-server-exception.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InternalServerException = void 0;
+class InternalServerException extends Error {
+}
+exports.InternalServerException = InternalServerException;
+//# sourceMappingURL=internal-server-exception.js.map

package/bin/src/exceptions/internal-server-exception.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"internal-server-exception.js","sourceRoot":"","sources":["../../../src/exceptions/internal-server-exception.ts"],"names":[],"mappings":";;;AAAA,MAAa,uBAAwB,SAAQ,KAAK;CACjD;AADD,0DACC"}

package/bin/src/exceptions/not-found-exception.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotFoundException = void 0;
+class NotFoundException extends Error {
+}
+exports.NotFoundException = NotFoundException;
+//# sourceMappingURL=not-found-exception.js.map

package/bin/src/exceptions/not-found-exception.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"not-found-exception.js","sourceRoot":"","sources":["../../../src/exceptions/not-found-exception.ts"],"names":[],"mappings":";;;AAAA,MAAa,iBAAkB,SAAQ,KAAK;CAC3C;AADD,8CACC"}

package/bin/src/exceptions/property-not-available-exception.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PropertyNotAvailableException = void 0;
+class PropertyNotAvailableException extends Error {
+}
+exports.PropertyNotAvailableException = PropertyNotAvailableException;
+//# sourceMappingURL=property-not-available-exception.js.map

package/bin/src/exceptions/property-not-available-exception.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"property-not-available-exception.js","sourceRoot":"","sources":["../../../src/exceptions/property-not-available-exception.ts"],"names":[],"mappings":";;;AAAA,MAAa,6BAA8B,SAAQ,KAAK;CACvD;AADD,sEACC"}

package/bin/src/factories/DateFactory.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DateFactory = void 0;
+class DateFactory {
+    create(data, parameters) {
+        return new Date(parameters[0]);
+    }
+}
+exports.DateFactory = DateFactory;
+//# sourceMappingURL=DateFactory.js.map

package/bin/src/factories/DateFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DateFactory.js","sourceRoot":"","sources":["../../../src/factories/DateFactory.ts"],"names":[],"mappings":";;;AAGA,MAAa,WAAW;IAChB,MAAM,CAAC,IAAW,EAAE,UAAoB;QAC9C,OAAO,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;IAChC,CAAC;CACD;AAJD,kCAIC"}

package/bin/src/factories/InternalLinkFactory.d.ts

@@ -0,0 +1,9 @@
+import { IClassFactory } from "../i-class-factory";
+import { CallableReturnType, Model } from "../types";
+import { PortalMap } from "../types/portal-map";
+export declare class InternalLinkFactory implements IClassFactory {
+    private portalMap;
+    constructor(portalMap: PortalMap);
+    create(link: Model): CallableReturnType;
+    private getPortalBaseUrl;
+}

package/bin/src/factories/InternalLinkFactory.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InternalLinkFactory = void 0;
+class InternalLinkFactory {
+    constructor(portalMap) {
+        this.portalMap = portalMap;
+    }
+    create(link) {
+        const portalBaseUrl = this.getPortalBaseUrl(link.getPortalType());
+        const path = link['getUrl']();
+        link['getUrl'] = () => portalBaseUrl + path;
+        return link;
+    }
+    getPortalBaseUrl(portalType) {
+        const url = this.portalMap.get(portalType);
+        return url || '';
+    }
+}
+exports.InternalLinkFactory = InternalLinkFactory;
+//# sourceMappingURL=InternalLinkFactory.js.map

package/bin/src/factories/InternalLinkFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InternalLinkFactory.js","sourceRoot":"","sources":["../../../src/factories/InternalLinkFactory.ts"],"names":[],"mappings":";;;AAKA,MAAa,mBAAmB;IAG/B,YAAY,SAAoB;QAC/B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC5B,CAAC;IAEM,MAAM,CAAC,IAAW;QACxB,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,aAAa,EAAgB,CAAC,CAAC;QAEhF,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,EAAY,CAAC;QACxC,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAW,EAAE,CAAC,aAAa,GAAG,IAAI,CAAC;QAEpD,OAAO,IAAI,CAAC;IACb,CAAC;IAEO,gBAAgB,CAAC,UAAsB;QAC9C,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC3C,OAAO,GAAG,IAAI,EAAE,CAAC;IAClB,CAAC;CAED;AArBD,kDAqBC"}

package/bin/src/i-api-response.d.ts

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

package/bin/src/i-api-response.js

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

package/bin/src/i-api-response.js.map

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

package/bin/src/i-class-factory.js

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

package/bin/src/i-class-factory.js.map

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