@studyportals/domain-client 6.1.1-beta.1 → 6.3.0-beta.0

package/index.d.ts

@@ -71,6 +71,8 @@ import { PublicScholarshipCardClient } from "./src/models/scholarship-card/publi
 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 { ICitySearchDocument } from "./src/models/city-search-document/i-city-search-document";
+import { CitySearchDocumentClient } from "./src/models/city-search-document/city-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";
@@ -83,6 +85,6 @@ 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 { 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, ICitySearchDocument, CitySearchDocumentClient, 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

@@ -23,11 +23,12 @@ import { SitemapCitiesInfoClient } from "./src/models/sitemap-cities-info/sitema
 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 { CitySearchDocumentClient } from "./src/models/city-search-document/city-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 { BadRequestException, ClientException, InternalServerException, NotFoundException, PropertyNotAvailableException, ProgrammeCardClient, SearchProjectionClient, BestfitProgrammeClient, CustomerIOProgrammeClient, PublicFaqStaticContentClient, SitemapProgrammeInfoClient, SitemapCountriesInfoClient, SitemapCountryDegreeInfoClient, PublicSearchDisciplineClient, SitemapDisciplinesInfoClient, CustomerIOOrganisationClient, SitemapOrganisationsInfoClient, OrganisationSearchDocumentClient, SitemapRankingsInfoClient, SitemapArticlesInfoClient, SitemapCitiesInfoClient, PublicScholarshipCardClient, ScholarshipCardV2Client, ScholarshipSearchDocumentClient, CitySearchDocumentClient, PortalType, ModelClient, PublicOrganisationForSearchClient, OrganisationCardClient, CopilotProgrammeClient, CopilotCountryClient };
 export * from './src/clients';
 export * from './protobuf';

package/package.json

@@ -1,50 +1,50 @@
-{
-	"name": "@studyportals/domain-client",
-	"version": "6.1.1-beta.1",
-	"description": "Responsible for fetching data from the Domain API",
-	"main": "index.js",
-	"author": "StudyPortals B.V.",
-	"sideEffects": false,
-	"contributors": [
-		"braaibander <danny@studyportals.com>"
-	],
-	"license": "BSD-3-Clause",
-	"scripts": {
-		"build": "tsc",
-		"test": "vitest run",
-		"test:watch": "vitest",
-		"coverage": "vitest run --coverage",
-		"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"
-		}
-	},
-	"devDependencies": {
-		"@studyportals/code-style": "^2.0.4",
-		"@types/node": "^24.2.1",
-		"@types/reflect-metadata": "^0.1.0",
-		"@typescript-eslint/eslint-plugin": "^4.8.1",
-		"@typescript-eslint/parser": "^4.8.1",
-		"@vitest/coverage-v8": "^3.2.4",
-		"eslint": "^7.13.0",
-		"eslint-plugin-import": "^2.22.1",
-		"eslint-plugin-mocha": "^10.1.0",
-		"husky": "^4.3.0",
-		"nyc": "^15.1.0",
-		"source-map-support": "^0.5.19",
-		"tslint": "^6.1.3",
-		"typemoq": "^2.1.0",
-		"typescript": "^5.9.2",
-		"vitest": "^3.2.4"
-	}
-}
+{
+	"name": "@studyportals/domain-client",
+	"version": "6.3.0-beta.0",
+	"description": "Responsible for fetching data from the Domain API",
+	"main": "index.js",
+	"author": "StudyPortals B.V.",
+	"sideEffects": false,
+	"contributors": [
+		"braaibander <danny@studyportals.com>"
+	],
+	"license": "BSD-3-Clause",
+	"scripts": {
+		"build": "tsc",
+		"test": "vitest run",
+		"test:watch": "vitest",
+		"coverage": "vitest run --coverage",
+		"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 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"
+		}
+	},
+	"devDependencies": {
+		"@studyportals/code-style": "^2.0.4",
+		"@types/node": "^24.2.1",
+		"@types/reflect-metadata": "^0.1.0",
+		"@typescript-eslint/eslint-plugin": "^4.8.1",
+		"@typescript-eslint/parser": "^4.8.1",
+		"@vitest/coverage-v8": "^3.2.4",
+		"eslint": "^7.13.0",
+		"eslint-plugin-import": "^2.22.1",
+		"eslint-plugin-mocha": "^10.1.0",
+		"husky": "^4.3.0",
+		"nyc": "^15.1.0",
+		"source-map-support": "^0.5.19",
+		"tslint": "^6.1.3",
+		"typemoq": "^2.1.0",
+		"typescript": "^5.9.2",
+		"vitest": "^3.2.4"
+	}
+}

package/src/models/city-search-document/city-search-document-client.d.ts

@@ -0,0 +1,7 @@
+import { ModelClient } from "../../model-client";
+import { ICitySearchDocument } from "../../..";
+export declare class CitySearchDocumentClient extends ModelClient<ICitySearchDocument> {
+    protected getModelName(): string;
+    protected getVersion(): string;
+    isPublic(): boolean;
+}

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

@@ -0,0 +1,12 @@
+import { ModelClient } from "../../model-client";
+export class CitySearchDocumentClient extends ModelClient {
+    getModelName() {
+        return 'city-search-document';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}

package/src/models/city-search-document/i-city-search-document.d.ts

@@ -0,0 +1,7 @@
+export interface ICitySearchDocument {
+    getId(): number;
+    getName(): string;
+    getVirtualPath(): string;
+    getAreaId(): number;
+    getCountryIsoCode(): string;
+}

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

@@ -0,0 +1 @@
+export {};