@studyportals/domain-client 7.0.0 → 7.0.1-beta.1

package/protobuf/index.js

@@ -1,45 +1,61 @@
+"use strict";
 /**
  * @file Automatically generated by barrelsby.
  */
-export * from "./Area";
-export * from "./Article";
-export * from "./Body";
-export * from "./CampaignInformation";
-export * from "./ClickTracking";
-export * from "./CommercialEntity";
-export * from "./Cover";
-export * from "./Deadline";
-export * from "./Degree";
-export * from "./Description";
-export * from "./Discipline";
-export * from "./Duration";
-export * from "./EnglishRequirement";
-export * from "./EssentialInformation";
-export * from "./File";
-export * from "./GPARequirement";
-export * from "./InternalLink";
-export * from "./Link";
-export * from "./LivingCost";
-export * from "./Location";
-export * from "./Logo";
-export * from "./MiniProgrammeCard";
-export * from "./OptionalLink";
-export * from "./Organisation";
-export * from "./OrganisationInformation";
-export * from "./OrganisationRanking";
-export * from "./Person";
-export * from "./ProgrammeCard";
-export * from "./ProgrammeGrid";
-export * from "./Ranking";
-export * from "./RankingInstitute";
-export * from "./Review";
-export * from "./ReviewRating";
-export * from "./RichText";
-export * from "./SocialLink";
-export * from "./StartDate";
-export * from "./Timing";
-export * from "./Topic";
-export * from "./TrackedLink";
-export * from "./Tracking";
-export * from "./TuitionFee";
-export * from "./Unibuddy";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Area"), exports);
+__exportStar(require("./Article"), exports);
+__exportStar(require("./Body"), exports);
+__exportStar(require("./CampaignInformation"), exports);
+__exportStar(require("./ClickTracking"), exports);
+__exportStar(require("./CommercialEntity"), exports);
+__exportStar(require("./Cover"), exports);
+__exportStar(require("./Deadline"), exports);
+__exportStar(require("./Degree"), exports);
+__exportStar(require("./Description"), exports);
+__exportStar(require("./Discipline"), exports);
+__exportStar(require("./Duration"), exports);
+__exportStar(require("./EnglishRequirement"), exports);
+__exportStar(require("./EssentialInformation"), exports);
+__exportStar(require("./File"), exports);
+__exportStar(require("./GPARequirement"), exports);
+__exportStar(require("./InternalLink"), exports);
+__exportStar(require("./Link"), exports);
+__exportStar(require("./LivingCost"), exports);
+__exportStar(require("./Location"), exports);
+__exportStar(require("./Logo"), exports);
+__exportStar(require("./MiniProgrammeCard"), exports);
+__exportStar(require("./OptionalLink"), exports);
+__exportStar(require("./Organisation"), exports);
+__exportStar(require("./OrganisationInformation"), exports);
+__exportStar(require("./OrganisationRanking"), exports);
+__exportStar(require("./Person"), exports);
+__exportStar(require("./ProgrammeCard"), exports);
+__exportStar(require("./ProgrammeGrid"), exports);
+__exportStar(require("./Ranking"), exports);
+__exportStar(require("./RankingInstitute"), exports);
+__exportStar(require("./Review"), exports);
+__exportStar(require("./ReviewRating"), exports);
+__exportStar(require("./RichText"), exports);
+__exportStar(require("./SocialLink"), exports);
+__exportStar(require("./StartDate"), exports);
+__exportStar(require("./Timing"), exports);
+__exportStar(require("./Topic"), exports);
+__exportStar(require("./TrackedLink"), exports);
+__exportStar(require("./Tracking"), exports);
+__exportStar(require("./TuitionFee"), exports);
+__exportStar(require("./Unibuddy"), exports);

package/src/clients/article-detail-page-client.js

@@ -1,8 +1,11 @@
-import { Article } from "../../protobuf";
-import { ProtobufClient } from "./protobuf-client";
-export class ArticleDetailPageClient extends ProtobufClient {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArticleDetailPageClient = void 0;
+const protobuf_1 = require("../../protobuf");
+const protobuf_client_1 = require("./protobuf-client");
+class ArticleDetailPageClient extends protobuf_client_1.ProtobufClient {
     constructModel(data) {
-        return Article.fromJSON(data);
+        return protobuf_1.Article.fromJSON(data);
     }
     getModelName() {
         return 'article-detail-page';
@@ -14,3 +17,4 @@ export class ArticleDetailPageClient extends ProtobufClient {
         return false;
     }
 }
+exports.ArticleDetailPageClient = ArticleDetailPageClient;

package/src/clients/index.js

@@ -1,7 +1,23 @@
+"use strict";
 /**
  * @file Automatically generated by barrelsby.
  */
-export * from "./article-detail-page-client";
-export * from "./organisation-page-client";
-export * from "./protobuf-client";
-export * from "./public-mini-programme-card-client";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./article-detail-page-client"), exports);
+__exportStar(require("./organisation-page-client"), exports);
+__exportStar(require("./protobuf-client"), exports);
+__exportStar(require("./public-mini-programme-card-client"), exports);

package/src/clients/organisation-page-client.js

@@ -1,8 +1,11 @@
-import { Organisation } from "../../protobuf";
-import { ProtobufClient } from "./protobuf-client";
-export class OrganisationPageClient extends ProtobufClient {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrganisationPageClient = void 0;
+const protobuf_1 = require("../../protobuf");
+const protobuf_client_1 = require("./protobuf-client");
+class OrganisationPageClient extends protobuf_client_1.ProtobufClient {
     constructModel(data) {
-        return Organisation.fromJSON(data);
+        return protobuf_1.Organisation.fromJSON(data);
     }
     getModelName() {
         return 'organisation-page';
@@ -14,3 +17,4 @@ export class OrganisationPageClient extends ProtobufClient {
         return false;
     }
 }
+exports.OrganisationPageClient = OrganisationPageClient;

package/src/clients/protobuf-client.js

@@ -1,12 +1,15 @@
-import { DomainClient } from "../domain-client";
-export class ProtobufClient {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProtobufClient = void 0;
+const domain_client_1 = require("../domain-client");
+class ProtobufClient {
     static portalMap = new Map();
     domainClient;
     constructor(baseUrl, seed, apiKey, portalMap) {
         if (portalMap) {
             ProtobufClient.portalMap = portalMap;
         }
-        this.domainClient = new DomainClient(baseUrl, apiKey, this.getModelName(), this.getVersion(), this.isPublic(), seed);
+        this.domainClient = new domain_client_1.DomainClient(baseUrl, apiKey, this.getModelName(), this.getVersion(), this.isPublic(), seed);
     }
     async fetch(id) {
         const results = await this.domainClient.doRequest([id]);
@@ -24,3 +27,4 @@ export class ProtobufClient {
         return path;
     }
 }
+exports.ProtobufClient = ProtobufClient;

package/src/clients/public-mini-programme-card-client.js

@@ -1,8 +1,11 @@
-import { MiniProgrammeCard } from "../../protobuf";
-import { ProtobufClient } from "./protobuf-client";
-export class PublicMiniProgrammeCardClient extends ProtobufClient {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PublicMiniProgrammeCardClient = void 0;
+const protobuf_1 = require("../../protobuf");
+const protobuf_client_1 = require("./protobuf-client");
+class PublicMiniProgrammeCardClient extends protobuf_client_1.ProtobufClient {
     constructModel(data) {
-        return MiniProgrammeCard.fromJSON(data);
+        return protobuf_1.MiniProgrammeCard.fromJSON(data);
     }
     getModelName() {
         return 'mini-programme-card';
@@ -14,3 +17,4 @@ export class PublicMiniProgrammeCardClient extends ProtobufClient {
         return true;
     }
 }
+exports.PublicMiniProgrammeCardClient = PublicMiniProgrammeCardClient;

package/src/domain-client.js

@@ -1,8 +1,11 @@
-import { BadRequestException } from "./exceptions/bad-request-exception";
-import { InternalServerException } from "./exceptions/internal-server-exception";
-import { NotFoundException } from "./exceptions/not-found-exception";
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DomainClient = void 0;
+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");
 const decoder = new TextDecoder();
-export class DomainClient {
+class DomainClient {
     baseUrl;
     apiKey;
     model;
@@ -52,10 +55,10 @@ export class DomainClient {
         }
         catch (error) {
             console.error('Error fetching data from API:', error);
-            if (error instanceof InternalServerException || error instanceof BadRequestException || error instanceof NotFoundException) {
+            if (error instanceof internal_server_exception_1.InternalServerException || error instanceof bad_request_exception_1.BadRequestException || error instanceof not_found_exception_1.NotFoundException) {
                 throw error;
             }
-            throw new InternalServerException('Unable to fetch data from the API', error);
+            throw new internal_server_exception_1.InternalServerException('Unable to fetch data from the API', error);
         }
     }
     async decompressModelData(compressedData) {
@@ -68,13 +71,13 @@ export class DomainClient {
     }
     handleErrors(response) {
         if (!response.status) {
-            throw new InternalServerException(response.message);
+            throw new internal_server_exception_1.InternalServerException(response.message);
         }
         if (response.status === 400) {
-            throw new BadRequestException(response.message);
+            throw new bad_request_exception_1.BadRequestException(response.message);
         }
         if (response.status === 404) {
-            throw new NotFoundException(response.message);
+            throw new not_found_exception_1.NotFoundException(response.message);
         }
     }
     buildUrl(ids) {
@@ -89,3 +92,4 @@ export class DomainClient {
         return this.isPublic && this.apiKey === undefined;
     }
 }
+exports.DomainClient = DomainClient;

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

@@ -1,2 +1,6 @@
-export class BadRequestException extends Error {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BadRequestException = void 0;
+class BadRequestException extends Error {
 }
+exports.BadRequestException = BadRequestException;

package/src/exceptions/client-exception.js

@@ -1,2 +1,6 @@
-export class ClientException extends Error {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClientException = void 0;
+class ClientException extends Error {
 }
+exports.ClientException = ClientException;

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

@@ -1,2 +1,6 @@
-export class InternalServerException extends Error {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InternalServerException = void 0;
+class InternalServerException extends Error {
 }
+exports.InternalServerException = InternalServerException;

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

@@ -1,2 +1,6 @@
-export class NotFoundException extends Error {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotFoundException = void 0;
+class NotFoundException extends Error {
 }
+exports.NotFoundException = NotFoundException;

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

@@ -1,2 +1,6 @@
-export class PropertyNotAvailableException extends Error {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PropertyNotAvailableException = void 0;
+class PropertyNotAvailableException extends Error {
 }
+exports.PropertyNotAvailableException = PropertyNotAvailableException;

package/src/factories/DateFactory.js

@@ -1,5 +1,9 @@
-export class DateFactory {
+"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;

package/src/factories/InternalLinkFactory.js

@@ -1,4 +1,7 @@
-export class InternalLinkFactory {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InternalLinkFactory = void 0;
+class InternalLinkFactory {
     portalMap;
     constructor(portalMap) {
         this.portalMap = portalMap;
@@ -20,3 +23,4 @@ export class InternalLinkFactory {
         return url || '';
     }
 }
+exports.InternalLinkFactory = InternalLinkFactory;

package/src/i-api-response.js

@@ -1 +1,2 @@
-export {};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/i-class-factory.js

@@ -1 +1,2 @@
-export {};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/i-model-description.js

@@ -1,5 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isModelDescription = isModelDescription;
 // eslint-disable-next-line
-export function isModelDescription(arg) {
+function isModelDescription(arg) {
     // eslint-disable-next-line
     return arg && arg.class && (arg.func || arg.parameters);
 }

package/src/model-client.js

@@ -1,15 +1,18 @@
-import { DomainClient } from "./domain-client";
-import { ClientException } from "./exceptions/client-exception";
-import { ModelFactory } from "./model-factory";
-export class ModelClient {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModelClient = void 0;
+const domain_client_1 = require("./domain-client");
+const client_exception_1 = require("./exceptions/client-exception");
+const model_factory_1 = require("./model-factory");
+class ModelClient {
     domainClient;
     modelFactory;
     constructor(baseUrl, apiKey, seed, portalMap) {
         if (!baseUrl || !seed) {
             return;
         }
-        this.modelFactory = new ModelFactory(portalMap);
-        this.domainClient = new DomainClient(baseUrl, apiKey, this.getModelName(), this.getVersion(), this.isPublic(), seed);
+        this.modelFactory = new model_factory_1.ModelFactory(portalMap);
+        this.domainClient = new domain_client_1.DomainClient(baseUrl, apiKey, this.getModelName(), this.getVersion(), this.isPublic(), seed);
     }
     async fetch(id) {
         const modelDescriptions = await this.fetchDescription(id);
@@ -17,7 +20,7 @@ export class ModelClient {
     }
     async fetchDescription(id) {
         if (!this.domainClient) {
-            throw new ClientException("Offline mode active: did you provide all parameters " +
+            throw new client_exception_1.ClientException("Offline mode active: did you provide all parameters " +
                 "in the constructor?");
         }
         const result = await this.domainClient.doRequest([id]);
@@ -29,7 +32,7 @@ export class ModelClient {
     }
     async fetchMultipleDescriptions(ids) {
         if (!this.domainClient) {
-            throw new ClientException('Offline mode active: did you provide all parameters ' +
+            throw new client_exception_1.ClientException('Offline mode active: did you provide all parameters ' +
                 'in the constructor?');
         }
         return await this.domainClient.doRequest(ids);
@@ -41,3 +44,4 @@ export class ModelClient {
         return this.modelFactory.fromDescriptions(descriptions);
     }
 }
+exports.ModelClient = ModelClient;

package/src/model-factory.js

@@ -1,13 +1,16 @@
-import { InternalLinkFactory } from "./factories/InternalLinkFactory";
-import { DateFactory } from "./factories/DateFactory";
-import { isModelDescription } from "./i-model-description";
-import { PropertyNotAvailableException } from "./exceptions/property-not-available-exception";
-export class ModelFactory {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModelFactory = void 0;
+const InternalLinkFactory_1 = require("./factories/InternalLinkFactory");
+const DateFactory_1 = require("./factories/DateFactory");
+const i_model_description_1 = require("./i-model-description");
+const property_not_available_exception_1 = require("./exceptions/property-not-available-exception");
+class ModelFactory {
     customClassFactories;
     constructor(portalMap = new Map()) {
         const factories = new Map();
-        factories.set('IInternalLink', new InternalLinkFactory(portalMap));
-        factories.set('SerializableDateTime', new DateFactory());
+        factories.set('IInternalLink', new InternalLinkFactory_1.InternalLinkFactory(portalMap));
+        factories.set('SerializableDateTime', new DateFactory_1.DateFactory());
         this.customClassFactories = factories;
     }
     fromDescription(data) {
@@ -36,7 +39,7 @@ export class ModelFactory {
         const canShowFunction = 'canShow' + propertyName;
         const value = data.func[functionName];
         let returnValue;
-        if (isModelDescription(value)) {
+        if ((0, i_model_description_1.isModelDescription)(value)) {
             returnValue = this.unpackClass(value);
         }
         else if (Array.isArray(value)) {
@@ -48,7 +51,7 @@ export class ModelFactory {
         if (canShowFunction in data.func) {
             return () => {
                 if (data.func[canShowFunction] === false) {
-                    throw new PropertyNotAvailableException(`Property '${propertyName}' not available`);
+                    throw new property_not_available_exception_1.PropertyNotAvailableException(`Property '${propertyName}' not available`);
                 }
                 return returnValue;
             };
@@ -59,10 +62,11 @@ export class ModelFactory {
     }
     unpackArray(list) {
         return list.map(item => {
-            if (isModelDescription(item)) {
+            if ((0, i_model_description_1.isModelDescription)(item)) {
                 return this.unpackClass(item);
             }
             return item;
         });
     }
 }
+exports.ModelFactory = ModelFactory;

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

@@ -1,5 +1,8 @@
-import { ModelClient } from "../../model-client";
-export class BestfitProgrammeClient extends ModelClient {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BestfitProgrammeClient = void 0;
+const model_client_1 = require("../../model-client");
+class BestfitProgrammeClient extends model_client_1.ModelClient {
     getModelName() {
         return 'bestfit-programme';
     }
@@ -10,3 +13,4 @@ export class BestfitProgrammeClient extends ModelClient {
         return false;
     }
 }
+exports.BestfitProgrammeClient = BestfitProgrammeClient;

package/src/models/bestfit-programme/i-best-fit-programme.js

@@ -1 +1,2 @@
-export {};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/bestfit-programme/i-city.js

@@ -1 +1,2 @@
-export {};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/bestfit-programme/i-living-cost.js

@@ -1 +1,2 @@
-export {};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,5 +1,8 @@
-import { ModelClient } from "../../model-client";
-export class CitySearchDocumentClient extends ModelClient {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CitySearchDocumentClient = void 0;
+const model_client_1 = require("../../model-client");
+class CitySearchDocumentClient extends model_client_1.ModelClient {
     getModelName() {
         return 'city-search-document';
     }
@@ -10,3 +13,4 @@ export class CitySearchDocumentClient extends ModelClient {
         return false;
     }
 }
+exports.CitySearchDocumentClient = CitySearchDocumentClient;

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

@@ -1 +1,2 @@
-export {};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/common/i-city.js

@@ -1 +1,2 @@
-export {};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/common/i-country.js

@@ -1 +1,2 @@
-export {};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/common/i-english-requirements.js

@@ -1 +1,2 @@
-export {};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/common/i-g-p-a-requirement.js

@@ -1 +1,2 @@
-export {};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/common/i-internal-link.js

@@ -1 +1,2 @@
-export {};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/common/i-logo.js

@@ -1 +1,2 @@
-export {};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/common/i-review-rating.js

@@ -1 +1,2 @@
-export {};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/common/i-tuition-fee.js

@@ -1 +1,2 @@
-export {};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/copilot-country/copilot-country-client.js

@@ -1,5 +1,8 @@
-import { ModelClient } from "../../model-client";
-export class CopilotCountryClient extends ModelClient {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CopilotCountryClient = void 0;
+const model_client_1 = require("../../model-client");
+class CopilotCountryClient extends model_client_1.ModelClient {
     getModelName() {
         return 'copilot-country';
     }
@@ -10,3 +13,4 @@ export class CopilotCountryClient extends ModelClient {
         return false;
     }
 }
+exports.CopilotCountryClient = CopilotCountryClient;

package/src/models/copilot-country/i-copilot-country.js

@@ -1 +1,2 @@
-export {};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/copilot-country/i-copilot-ranking-card.js

@@ -1 +1,2 @@
-export {};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,5 +1,8 @@
-import { ModelClient } from "../../model-client";
-export class CopilotProgrammeClient extends ModelClient {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CopilotProgrammeClient = void 0;
+const model_client_1 = require("../../model-client");
+class CopilotProgrammeClient extends model_client_1.ModelClient {
     getModelName() {
         return 'copilot-programme';
     }
@@ -10,3 +13,4 @@ export class CopilotProgrammeClient extends ModelClient {
         return false;
     }
 }
+exports.CopilotProgrammeClient = CopilotProgrammeClient;

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

@@ -1 +1,2 @@
-export {};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });