@studyportals/domain-client 6.2.1-beta.5 → 6.3.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts CHANGED
@@ -71,6 +71,8 @@ import { PublicScholarshipCardClient } from "./src/models/scholarship-card/publi
71
71
  import { ScholarshipCardV2Client } from "./src/models/scholarship-card/scholarship-card-v2-client";
72
72
  import { IScholarshipSearchDocument } from "./src/models/scholarship-search-document/i-scholarship-search-document";
73
73
  import { ScholarshipSearchDocumentClient } from "./src/models/scholarship-search-document/scholarship-search-document-client";
74
+ import { ICitySearchDocument } from "./src/models/city-search-document/i-city-search-document";
75
+ import { CitySearchDocumentClient } from "./src/models/city-search-document/city-search-document-client";
74
76
  import { IRanking } from './src/models/ranking-cards/i-ranking';
75
77
  import { PortalType } from "./src/types/portal-type";
76
78
  import { PortalMap } from "./src/types/portal-map";
@@ -83,6 +85,6 @@ import { ICopilotCountry } from "./src/models/copilot-country/i-copilot-country"
83
85
  import { CopilotCountryClient } from "./src/models/copilot-country/copilot-country-client";
84
86
  import { ICopilotRankingCard } from "./src/models/copilot-country/i-copilot-ranking-card";
85
87
  import { IReviewRating } from "./src/models/common/i-review-rating";
86
- 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 };
88
+ 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 };
87
89
  export * from './src/clients';
88
90
  export * from './protobuf';
package/index.js CHANGED
@@ -23,11 +23,12 @@ import { SitemapCitiesInfoClient } from "./src/models/sitemap-cities-info/sitema
23
23
  import { PublicScholarshipCardClient } from "./src/models/scholarship-card/public-scholarship-card-client";
24
24
  import { ScholarshipCardV2Client } from "./src/models/scholarship-card/scholarship-card-v2-client";
25
25
  import { ScholarshipSearchDocumentClient } from "./src/models/scholarship-search-document/scholarship-search-document-client";
26
+ import { CitySearchDocumentClient } from "./src/models/city-search-document/city-search-document-client";
26
27
  import { PortalType } from "./src/types/portal-type";
27
28
  import { ModelClient } from "./src/model-client";
28
29
  import { PublicOrganisationForSearchClient } from "./src/models/organisation-for-search/public-organisation-for-search-client";
29
30
  import { CopilotProgrammeClient } from "./src/models/copilot-programme/copilot-programme-client";
30
31
  import { CopilotCountryClient } from "./src/models/copilot-country/copilot-country-client";
31
- 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 };
32
+ 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 };
32
33
  export * from './src/clients';
33
34
  export * from './protobuf';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@studyportals/domain-client",
3
- "version": "6.2.1-beta.5",
3
+ "version": "6.3.0-beta.1",
4
4
  "description": "Responsible for fetching data from the Domain API",
5
5
  "main": "index.js",
6
6
  "author": "StudyPortals B.V.",
@@ -18,7 +18,7 @@
18
18
  "lint:fix": "eslint . --ext .ts --fix",
19
19
  "pre-push": "npm run test && npm run coverage && npm run lint",
20
20
  "prepare-dist": "npm run test && rm -fR bin && npx tsc && cp package.json bin/package.json && rm -fR bin/tests",
21
- "publish-beta": "npm version prerelease --preid=beta && npm run prepare-dist && npm publish ./bin --tag beta",
21
+ "publish-beta": "npm run prepare-dist && npm publish ./bin --tag beta",
22
22
  "publish-major": "npm version major && npm run prepare-dist && npm publish ./bin",
23
23
  "publish-minor": "npm version minor && npm run prepare-dist && npm publish ./bin",
24
24
  "publish-patch": "npm version patch && npm run prepare-dist && npm publish ./bin",
@@ -0,0 +1,7 @@
1
+ import { ModelClient } from "../../model-client";
2
+ import { ICitySearchDocument } from "../../..";
3
+ export declare class CitySearchDocumentClient extends ModelClient<ICitySearchDocument> {
4
+ protected getModelName(): string;
5
+ protected getVersion(): string;
6
+ isPublic(): boolean;
7
+ }
@@ -0,0 +1,12 @@
1
+ import { ModelClient } from "../../model-client";
2
+ export class CitySearchDocumentClient extends ModelClient {
3
+ getModelName() {
4
+ return 'city-search-document';
5
+ }
6
+ getVersion() {
7
+ return 'v1';
8
+ }
9
+ isPublic() {
10
+ return false;
11
+ }
12
+ }
@@ -0,0 +1,7 @@
1
+ export interface ICitySearchDocument {
2
+ getId(): number;
3
+ getName(): string;
4
+ getVirtualPath(): string;
5
+ getAreaId(): number | null;
6
+ getCountryIsoCode(): string;
7
+ }
@@ -1,10 +1,9 @@
1
1
  import { IFaq } from "./i-faq";
2
- import { IStaticContent } from "./i-static-content";
2
+ import { IStaticContentUrl } from "./i-static-content-url";
3
3
  export interface IFaqStaticContent {
4
4
  getFaqId(): number | null;
5
5
  getStaticContentId(): number | null;
6
- getRankingFaqs(): IFaq[] | null;
7
- getSearchFaqs(): IFaq[] | null;
8
- getRankingStaticContent(): IStaticContent | null;
9
- getSearchStaticContent(): IStaticContent | null;
6
+ getFaqs(): IFaq[] | null;
7
+ getStaticContentText(): string | null;
8
+ getStaticContentUrls(): IStaticContentUrl[] | null;
10
9
  }
@@ -1,5 +0,0 @@
1
- import { IStaticContentUrl } from "./i-static-content-url";
2
- export interface IStaticContent {
3
- getUrls(): IStaticContentUrl[];
4
- getText(): string;
5
- }