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

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

@@ -0,0 +1,17 @@
+export interface ISitemapDisciplineInfo {
+
+	/**
+	 * @return number
+	 */
+	getId(): number;
+
+	/**
+	 * @return string
+	 */
+	getPath(): string;
+
+	/**
+	 * @return boolean
+	 */
+	shouldBeInSitemap(): boolean;
+}

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

@@ -0,0 +1,16 @@
+import { ISitemapDisciplineInfo } from "../../..";
+import { ModelClient } from "../../model-client";
+
+export class SitemapDisciplinesInfoClient extends ModelClient<ISitemapDisciplineInfo> {
+	protected getModelName(): string {
+		return 'sitemap-disciplines-info';
+	}
+
+	protected getVersion(): string {
+		return 'v1';
+	}
+
+	public isPublic(): boolean {
+		return false;
+	}
+}

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

@@ -0,0 +1,32 @@
+export interface ISitemapOrganisationInfo {
+
+	/**
+	 * @return number
+	 */
+	getId(): number;
+
+	/**
+	 * @return string
+	 */
+	getPath(): string;
+
+	/**
+	 * @return boolean
+	 */
+	shouldBeInSitemapForBachelors(): boolean;
+
+	/**
+	 * @return boolean
+	 */
+	shouldBeInSitemapForMasters(): boolean;
+
+	/**
+	 * @return boolean
+	 */
+	shouldBeInSitemapForPhd(): boolean;
+
+	/**
+	 * @return boolean
+	 */
+	shouldBeInSitemapForShortCourses(): boolean;
+}

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

@@ -0,0 +1,16 @@
+import { ISitemapOrganisationInfo } from "../../..";
+import { ModelClient } from "../../model-client";
+
+export class SitemapOrganisationsInfoClient extends ModelClient<ISitemapOrganisationInfo> {
+	protected getModelName(): string {
+		return 'sitemap-organisations-info';
+	}
+
+	protected getVersion(): string {
+		return 'v1';
+	}
+
+	public isPublic(): boolean {
+		return false;
+	}
+}

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

@@ -0,0 +1,32 @@
+export interface ISitemapProgrammeInfo {
+
+	/**
+	 * @return number
+	 */
+	getId(): number;
+
+	/**
+	 * @return string
+	 */
+	getPath(): string;
+
+	/**
+	 * @return boolean
+	 */
+	shouldBeInSitemapForBachelors(): boolean;
+
+	/**
+	 * @return boolean
+	 */
+	shouldBeInSitemapForMasters(): boolean;
+
+	/**
+	 * @return boolean
+	 */
+	shouldBeInSitemapForPhd(): boolean;
+
+	/**
+	 * @return boolean
+	 */
+	shouldBeInSitemapForShortCourses(): boolean;
+}

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

@@ -0,0 +1,16 @@
+import { ISitemapProgrammeInfo } from "../../..";
+import { ModelClient } from "../../model-client";
+
+export class SitemapProgrammeInfoClient extends ModelClient<ISitemapProgrammeInfo> {
+	protected getModelName(): string {
+		return 'sitemap-programme-info';
+	}
+
+	protected getVersion(): string {
+		return 'v1';
+	}
+
+	public isPublic(): boolean {
+		return false;
+	}
+}

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

@@ -0,0 +1,17 @@
+export interface ISitemapRankingsInfo {
+
+	/**
+	 * @return number
+	 */
+	getId(): number;
+
+	/**
+	 * @return string
+	 */
+	getPath(): string;
+
+	/**
+	 * @return boolean
+	 */
+	shouldBeInSitemap(): boolean;
+}

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

@@ -0,0 +1,16 @@
+import { ISitemapRankingsInfo } from "../../..";
+import { ModelClient } from "../../model-client";
+
+export class SitemapRankingsInfoClient extends ModelClient<ISitemapRankingsInfo> {
+	protected getModelName(): string {
+		return 'sitemap-rankings-info';
+	}
+
+	protected getVersion(): string {
+		return 'v1';
+	}
+
+	public isPublic(): boolean {
+		return false;
+	}
+}

package/src/types/portal-map.ts

@@ -0,0 +1,3 @@
+import { PortalType } from "./portal-type";
+
+export type PortalMap = Map<PortalType, string>

package/src/types/portal-type.ts

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

package/src/types.ts

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

package/tsconfig.json

@@ -0,0 +1,40 @@
+{
+	"compilerOptions": {
+		"outDir": "bin",
+		"rootDir": "",
+		"moduleResolution": "node",
+		"declaration": true,
+		"alwaysStrict": true,
+		"strictNullChecks": true,
+		"allowJs": false,
+		"allowUnreachableCode": false,
+		"allowUnusedLabels": false,
+		"noUnusedLocals": false,
+		"noUnusedParameters": false,
+
+		"noFallthroughCasesInSwitch": true,
+		"noImplicitAny": true,
+		"noImplicitReturns": true,
+		"noImplicitThis": true,
+
+		"sourceMap": false,
+
+		"target": "esnext",
+		"lib": ["esnext", "dom"],
+		"module": "esnext",
+		"experimentalDecorators": true,
+		"emitDecoratorMetadata": true,
+		"types": [
+			"reflect-metadata",
+			"node"
+		],
+		"skipLibCheck": true
+	},
+	"typeRoots": [
+		"node_modules/@types/"
+	],
+	"exclude": [
+		"node_modules",
+		"bin"
+	]
+}

package/vitest.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+	test: {
+		globals: true,
+		environment: 'node',
+		include: ['tests/**/*.test.ts'],
+		setupFiles: ['./vitest.setup.ts']
+	}
+});

package/vitest.setup.ts

@@ -0,0 +1,6 @@
+import { vi } from 'vitest';
+
+// Set up global fetch for testing
+global.fetch = vi.fn();
+
+// Add any other global test setup here

package/index.d.ts

@@ -1,88 +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/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 { IFaqStaticContent } from "./src/models/faq-static-content/i-faq-static-content";
-import { IFaq } from "./src/models/faq-static-content/i-faq";
-import { IStaticContentUrl } from "./src/models/faq-static-content/i-static-content-url";
-import { PublicFaqStaticContentClient } from "./src/models/faq-static-content/public-faq-static-content-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";
-import { IReviewRating } from "./src/models/common/i-review-rating";
-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, IFaqStaticContent, PublicFaqStaticContentClient, IFaq, IStaticContentUrl, 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, IReviewRating };
-export * from './src/clients';
-export * from './protobuf';

package/index.js

@@ -1,33 +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 { ProgrammeCardClient } from "./src/models/programme-card/programme-card-client";
-import { SearchProjectionClient } from "./src/models/search-projection/search-projection-client";
-import { BestfitProgrammeClient } from "./src/models/bestfit-programme/bestfit-programme-client";
-import { CustomerIOProgrammeClient } from "./src/models/customerio-programme/customerio-programme-client";
-import { PublicFaqStaticContentClient } from "./src/models/faq-static-content/public-faq-static-content-client";
-import { SitemapProgrammeInfoClient } from "./src/models/sitemap-programme-info/sitemap-programme-info-client";
-import { SitemapCountriesInfoClient } from "./src/models/sitemap-countries-info/sitemap-countries-info-client";
-import { SitemapCountryDegreeInfoClient } from "./src/models/sitemap-country-degree-info/sitemap-country-degree-info-client";
-import { PublicSearchDisciplineClient } from "./src/models/search-discipline/public-search-discipline-client";
-import { SitemapDisciplinesInfoClient } from "./src/models/sitemap-disciplines-info/sitemap-disciplines-info-client";
-import { CustomerIOOrganisationClient } from "./src/models/customerio-organisation/customerio-organisation-client";
-import { SitemapOrganisationsInfoClient } from "./src/models/sitemap-organisations-info/sitemap-organisations-info-client";
-import { OrganisationCardClient } from "./src/models/organisation-card/organisation-card-client";
-import { OrganisationSearchDocumentClient } from "./src/models/organisation-search-document/organisation-search-document-client";
-import { SitemapRankingsInfoClient } from "./src/models/sitemap-rankings-info/sitemap-rankings-info-client";
-import { SitemapArticlesInfoClient } from "./src/models/sitemap-articles-info/sitemap-articles-info-client";
-import { SitemapCitiesInfoClient } from "./src/models/sitemap-cities-info/sitemap-cities-info-client";
-import { PublicScholarshipCardClient } from "./src/models/scholarship-card/public-scholarship-card-client";
-import { ScholarshipCardV2Client } from "./src/models/scholarship-card/scholarship-card-v2-client";
-import { ScholarshipSearchDocumentClient } from "./src/models/scholarship-search-document/scholarship-search-document-client";
-import { PortalType } from "./src/types/portal-type";
-import { ModelClient } from "./src/model-client";
-import { PublicOrganisationForSearchClient } from "./src/models/organisation-for-search/public-organisation-for-search-client";
-import { CopilotProgrammeClient } from "./src/models/copilot-programme/copilot-programme-client";
-import { CopilotCountryClient } from "./src/models/copilot-country/copilot-country-client";
-export { BadRequestException, ClientException, InternalServerException, NotFoundException, PropertyNotAvailableException, ProgrammeCardClient, SearchProjectionClient, BestfitProgrammeClient, CustomerIOProgrammeClient, PublicFaqStaticContentClient, SitemapProgrammeInfoClient, SitemapCountriesInfoClient, SitemapCountryDegreeInfoClient, PublicSearchDisciplineClient, SitemapDisciplinesInfoClient, CustomerIOOrganisationClient, SitemapOrganisationsInfoClient, OrganisationSearchDocumentClient, SitemapRankingsInfoClient, SitemapArticlesInfoClient, SitemapCitiesInfoClient, PublicScholarshipCardClient, ScholarshipCardV2Client, ScholarshipSearchDocumentClient, PortalType, ModelClient, PublicOrganisationForSearchClient, OrganisationCardClient, CopilotProgrammeClient, CopilotCountryClient };
-export * from './src/clients';
-export * from './protobuf';

package/protobuf/Area.d.ts

@@ -1,11 +0,0 @@
-export interface Area {
-    id: number;
-    name?: string | undefined;
-    code?: string | undefined;
-}
-export declare const Area: MessageFns<Area>;
-interface MessageFns<T> {
-    fromJSON(object: any): T;
-    toJSON(message: T): unknown;
-}
-export {};

package/protobuf/Area.js

@@ -1,30 +0,0 @@
-// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
-// versions:
-//   protoc-gen-ts_proto  v2.7.5
-//   protoc               v3.12.4
-// source: Area.proto
-export const Area = {
-    fromJSON(object) {
-        return {
-            id: isSet(object.id) ? globalThis.Number(object.id) : 0,
-            name: isSet(object.name) ? globalThis.String(object.name) : undefined,
-            code: isSet(object.code) ? globalThis.String(object.code) : undefined,
-        };
-    },
-    toJSON(message) {
-        const obj = {};
-        if (message.id !== 0) {
-            obj.id = Math.round(message.id);
-        }
-        if (message.name !== undefined) {
-            obj.name = message.name;
-        }
-        if (message.code !== undefined) {
-            obj.code = message.code;
-        }
-        return obj;
-    },
-};
-function isSet(value) {
-    return value !== null && value !== undefined;
-}

package/protobuf/Article.d.ts

@@ -1,60 +0,0 @@
-import { Discipline } from "./Discipline";
-import { File } from "./File";
-import { Country } from "./Organisation";
-import { Person } from "./Person";
-import { Topic } from "./Topic";
-export interface Article {
-    id: number;
-    name: string;
-    title: string;
-    summary: string;
-    description: string;
-    promo: string;
-    canonicalUrl: string;
-    /** string author = 8; */
-    type: string;
-    topicId: number;
-    date: string;
-    creationDate: string;
-    modifiedDate: string;
-    publishedDate: string;
-    isHighlighted: boolean;
-    hasSocialBookmarking: boolean;
-    visibility: string;
-    mayShowGallery: boolean;
-    urlName: string;
-    virtualPath: string;
-    tags: TagsArray | undefined;
-    relatedArticles: Article[];
-    relatedCountries: Country[];
-    relatedCities: number[];
-    relatedDisciplines: Discipline[];
-    relatedReviewCategories: number[];
-    relatedStudies: number[];
-    relatedOrganisations: number[];
-    featuredArticles: Article[];
-    recentArticles: Article[];
-    archivedArticles: Article[];
-    isPublic: boolean;
-    author: Person | undefined;
-    isSponsored: boolean;
-    topic: Topic | undefined;
-    image: File | undefined;
-    canBeIndexed: boolean;
-    roundedAmountOfProgrammes: number;
-}
-export interface TagsStruct {
-    id: string;
-    name: string;
-}
-export interface TagsArray {
-    tags: TagsStruct[];
-}
-export declare const Article: MessageFns<Article>;
-export declare const TagsStruct: MessageFns<TagsStruct>;
-export declare const TagsArray: MessageFns<TagsArray>;
-interface MessageFns<T> {
-    fromJSON(object: any): T;
-    toJSON(message: T): unknown;
-}
-export {};