@studyportals/domain-client 5.4.4-beta.5 → 5.5.0

package/src/domain-client.js

@@ -1,61 +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;
+"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/src/exceptions/bad-request-exception.d.ts

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

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

@@ -1,7 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BadRequestException = void 0;
-class BadRequestException extends Error {
-}
-exports.BadRequestException = BadRequestException;
+"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/src/exceptions/client-exception.d.ts

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

package/src/exceptions/client-exception.js

@@ -1,7 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ClientException = void 0;
-class ClientException extends Error {
-}
-exports.ClientException = ClientException;
+"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/src/exceptions/internal-server-exception.d.ts

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

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

@@ -1,7 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InternalServerException = void 0;
-class InternalServerException extends Error {
-}
-exports.InternalServerException = InternalServerException;
+"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/src/exceptions/not-found-exception.d.ts

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

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

@@ -1,7 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NotFoundException = void 0;
-class NotFoundException extends Error {
-}
-exports.NotFoundException = NotFoundException;
+"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/src/exceptions/property-not-available-exception.d.ts

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

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

@@ -1,7 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PropertyNotAvailableException = void 0;
-class PropertyNotAvailableException extends Error {
-}
-exports.PropertyNotAvailableException = PropertyNotAvailableException;
+"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/src/factories/DateFactory.d.ts

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

package/src/factories/DateFactory.js

@@ -1,10 +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;
+"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/src/factories/InternalLinkFactory.d.ts

@@ -1,9 +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;
-}
+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/src/factories/InternalLinkFactory.js

@@ -1,20 +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;
+"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/src/i-api-response.d.ts

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

package/src/i-api-response.js

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

package/src/i-class-factory.d.ts

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

package/src/i-class-factory.js

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

package/src/i-model-description.d.ts

@@ -1,7 +1,7 @@
-import { AcceptedType } from "./types";
-export interface IModelDescription {
-    class: string;
-    func: Record<string, AcceptedType | IModelDescription>;
-    parameters?: any[];
-}
-export declare function isModelDescription(arg: any): arg is IModelDescription;
+import { AcceptedType } from "./types";
+export interface IModelDescription {
+    class: string;
+    func: Record<string, AcceptedType | IModelDescription>;
+    parameters?: any[];
+}
+export declare function isModelDescription(arg: any): arg is IModelDescription;

package/src/i-model-description.js

@@ -1,10 +1,10 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isModelDescription = void 0;
-// eslint-disable-next-line
-function isModelDescription(arg) {
-    // eslint-disable-next-line
-    return arg && arg.class && (arg.func || arg.parameters);
-}
-exports.isModelDescription = isModelDescription;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isModelDescription = void 0;
+// eslint-disable-next-line
+function isModelDescription(arg) {
+    // eslint-disable-next-line
+    return arg && arg.class && (arg.func || arg.parameters);
+}
+exports.isModelDescription = isModelDescription;
 //# sourceMappingURL=i-model-description.js.map

package/src/model-client.d.ts

@@ -1,16 +1,16 @@
-import { IModelDescription } from "./i-model-description";
-import { PortalMap } from "./types/portal-map";
-export declare abstract class ModelClient<T> {
-    private readonly domainClient;
-    private readonly modelFactory;
-    constructor(baseUrl?: string, apiKey?: string, seed?: number, portalMap?: PortalMap);
-    fetch(id: number): Promise<T>;
-    fetchDescription(id: number): Promise<IModelDescription>;
-    fetchMultiple(ids: number[]): Promise<T[]>;
-    fetchMultipleDescriptions(ids: number[]): Promise<IModelDescription[]>;
-    fromDescription(description: IModelDescription): T;
-    fromDescriptions(descriptions: IModelDescription[]): T[];
-    protected abstract getModelName(): string;
-    protected abstract getVersion(): string;
-    abstract isPublic(): boolean;
-}
+import { IModelDescription } from "./i-model-description";
+import { PortalMap } from "./types/portal-map";
+export declare abstract class ModelClient<T> {
+    private readonly domainClient;
+    private readonly modelFactory;
+    constructor(baseUrl?: string, apiKey?: string, seed?: number, portalMap?: PortalMap);
+    fetch(id: number): Promise<T>;
+    fetchDescription(id: number): Promise<IModelDescription>;
+    fetchMultiple(ids: number[]): Promise<T[]>;
+    fetchMultipleDescriptions(ids: number[]): Promise<IModelDescription[]>;
+    fromDescription(description: IModelDescription): T;
+    fromDescriptions(descriptions: IModelDescription[]): T[];
+    protected abstract getModelName(): string;
+    protected abstract getVersion(): string;
+    abstract isPublic(): boolean;
+}

package/src/model-client.js

@@ -1,46 +1,46 @@
-"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 {
-    constructor(baseUrl, apiKey, seed, portalMap) {
-        if (!baseUrl || !seed) {
-            return;
-        }
-        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);
-        return this.modelFactory.fromDescription(modelDescriptions);
-    }
-    async fetchDescription(id) {
-        if (!this.domainClient) {
-            throw new client_exception_1.ClientException("Offline mode active: did you provide all parameters " +
-                "in the constructor?");
-        }
-        const result = await this.domainClient.doRequest([id]);
-        return result[0];
-    }
-    async fetchMultiple(ids) {
-        const descriptions = await this.fetchMultipleDescriptions(ids);
-        return this.modelFactory.fromDescriptions(descriptions);
-    }
-    async fetchMultipleDescriptions(ids) {
-        if (!this.domainClient) {
-            throw new client_exception_1.ClientException('Offline mode active: did you provide all parameters ' +
-                'in the constructor?');
-        }
-        return await this.domainClient.doRequest(ids);
-    }
-    fromDescription(description) {
-        return this.modelFactory.fromDescription(description);
-    }
-    fromDescriptions(descriptions) {
-        return this.modelFactory.fromDescriptions(descriptions);
-    }
-}
-exports.ModelClient = 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 {
+    constructor(baseUrl, apiKey, seed, portalMap) {
+        if (!baseUrl || !seed) {
+            return;
+        }
+        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);
+        return this.modelFactory.fromDescription(modelDescriptions);
+    }
+    async fetchDescription(id) {
+        if (!this.domainClient) {
+            throw new client_exception_1.ClientException("Offline mode active: did you provide all parameters " +
+                "in the constructor?");
+        }
+        const result = await this.domainClient.doRequest([id]);
+        return result[0];
+    }
+    async fetchMultiple(ids) {
+        const descriptions = await this.fetchMultipleDescriptions(ids);
+        return this.modelFactory.fromDescriptions(descriptions);
+    }
+    async fetchMultipleDescriptions(ids) {
+        if (!this.domainClient) {
+            throw new client_exception_1.ClientException('Offline mode active: did you provide all parameters ' +
+                'in the constructor?');
+        }
+        return await this.domainClient.doRequest(ids);
+    }
+    fromDescription(description) {
+        return this.modelFactory.fromDescription(description);
+    }
+    fromDescriptions(descriptions) {
+        return this.modelFactory.fromDescriptions(descriptions);
+    }
+}
+exports.ModelClient = ModelClient;
 //# sourceMappingURL=model-client.js.map

package/src/model-factory.d.ts

@@ -1,11 +1,11 @@
-import { IModelDescription } from "./i-model-description";
-import { PortalMap } from "./types/portal-map";
-export declare class ModelFactory<T> {
-    private customClassFactories;
-    constructor(portalMap?: PortalMap);
-    fromDescription(data: IModelDescription): T;
-    fromDescriptions(data: IModelDescription[]): T[];
-    private unpackClass;
-    private getCallable;
-    private unpackArray;
-}
+import { IModelDescription } from "./i-model-description";
+import { PortalMap } from "./types/portal-map";
+export declare class ModelFactory<T> {
+    private customClassFactories;
+    constructor(portalMap?: PortalMap);
+    fromDescription(data: IModelDescription): T;
+    fromDescriptions(data: IModelDescription[]): T[];
+    private unpackClass;
+    private getCallable;
+    private unpackArray;
+}