@studyportals/domain-client 3.10.0 → 3.11.0

package/index.d.ts

@@ -52,7 +52,9 @@ import { ISitemapRankingsInfo } from "./src/models/sitemap-rankings-info/i-sitem
 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 { PortalType } from "./src/types/portal-type";
 import { PortalMap } from "./src/types/portal-map";
 import { ModelClient } from "./src/model-client";
-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, IDotDigitalProgramme, DotdigitalProgrammeClient, ISearchCountryFaq, PublicSearchCountryFaqClient, ISitemapCountryInfo, SitemapCountriesInfoClient, ISearchDiscipline, PublicSearchDisciplineClient, ISitemapDisciplineInfo, SitemapDisciplinesInfoClient, ICountry, ICity, IReview, IDotDigitalOrganisation, DotdigitalOrganisationClient, ISitemapOrganisationInfo, SitemapOrganisationsInfoClient, ISitemapRankingsInfo, SitemapRankingsInfoClient, ISitemapArticleInfo, SitemapArticlesInfoClient, PortalType, PortalMap, ModelClient };
+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, IDotDigitalProgramme, DotdigitalProgrammeClient, ISearchCountryFaq, PublicSearchCountryFaqClient, ISitemapCountryInfo, SitemapCountriesInfoClient, ISearchDiscipline, PublicSearchDisciplineClient, ISitemapDisciplineInfo, SitemapDisciplinesInfoClient, ICountry, ICity, IReview, IDotDigitalOrganisation, DotdigitalOrganisationClient, ISitemapOrganisationInfo, SitemapOrganisationsInfoClient, ISitemapRankingsInfo, SitemapRankingsInfoClient, ISitemapArticleInfo, SitemapArticlesInfoClient, ISitemapCityInfo, SitemapCitiesInfoClient, PortalType, PortalMap, ModelClient };

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ModelClient = exports.PortalType = exports.SitemapArticlesInfoClient = exports.SitemapRankingsInfoClient = exports.SitemapOrganisationsInfoClient = exports.DotdigitalOrganisationClient = exports.SitemapDisciplinesInfoClient = exports.PublicSearchDisciplineClient = exports.SitemapCountriesInfoClient = exports.PublicSearchCountryFaqClient = exports.DotdigitalProgrammeClient = exports.BestfitProgrammeClient = exports.SearchProjectionClient = exports.ProgrammeCardClient = exports.PropertyNotAvailableException = exports.NotFoundException = exports.InternalServerException = exports.ClientException = exports.BadRequestException = void 0;
+exports.ModelClient = exports.PortalType = exports.SitemapCitiesInfoClient = exports.SitemapArticlesInfoClient = exports.SitemapRankingsInfoClient = exports.SitemapOrganisationsInfoClient = exports.DotdigitalOrganisationClient = exports.SitemapDisciplinesInfoClient = exports.PublicSearchDisciplineClient = exports.SitemapCountriesInfoClient = exports.PublicSearchCountryFaqClient = exports.DotdigitalProgrammeClient = exports.BestfitProgrammeClient = exports.SearchProjectionClient = exports.ProgrammeCardClient = exports.PropertyNotAvailableException = exports.NotFoundException = exports.InternalServerException = exports.ClientException = exports.BadRequestException = void 0;
 const bad_request_exception_1 = require("./src/exceptions/bad-request-exception");
 Object.defineProperty(exports, "BadRequestException", { enumerable: true, get: function () { return bad_request_exception_1.BadRequestException; } });
 const client_exception_1 = require("./src/exceptions/client-exception");
@@ -35,6 +35,8 @@ const sitemap_rankings_info_client_1 = require("./src/models/sitemap-rankings-in
 Object.defineProperty(exports, "SitemapRankingsInfoClient", { enumerable: true, get: function () { return sitemap_rankings_info_client_1.SitemapRankingsInfoClient; } });
 const sitemap_articles_info_client_1 = require("./src/models/sitemap-articles-info/sitemap-articles-info-client");
 Object.defineProperty(exports, "SitemapArticlesInfoClient", { enumerable: true, get: function () { return sitemap_articles_info_client_1.SitemapArticlesInfoClient; } });
+const sitemap_cities_info_client_1 = require("./src/models/sitemap-cities-info/sitemap-cities-info-client");
+Object.defineProperty(exports, "SitemapCitiesInfoClient", { enumerable: true, get: function () { return sitemap_cities_info_client_1.SitemapCitiesInfoClient; } });
 const portal_type_1 = require("./src/types/portal-type");
 Object.defineProperty(exports, "PortalType", { enumerable: true, get: function () { return portal_type_1.PortalType; } });
 const model_client_1 = require("./src/model-client");

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,kFAA4E;AA2D3E,oGA3DQ,2CAAmB,OA2DR;AA1DpB,wEAAmE;AA2DlE,gGA3DQ,kCAAe,OA2DR;AA1DhB,0FAAoF;AA2DnF,wGA3DQ,mDAAuB,OA2DR;AA1DxB,8EAAwE;AA2DvE,kGA3DQ,uCAAiB,OA2DR;AA1DlB,wGAAiG;AA2DhG,8GA3DQ,gEAA6B,OA2DR;AA3C9B,6FAAwF;AAwDvF,oGAxDQ,2CAAmB,OAwDR;AAjDpB,sGAAiG;AAwDhG,uGAxDQ,iDAAsB,OAwDR;AAlDvB,sGAAiG;AAsDhG,uGAtDQ,iDAAsB,OAsDR;AAnDvB,+GAA0G;AAyDzG,0GAzDQ,uDAAyB,OAyDR;AAvD1B,uHAAgH;AAyD/G,6GAzDQ,+DAA4B,OAyDR;AAvD7B,qHAA+G;AAyD9G,2GAzDQ,0DAA0B,OAyDR;AAvD3B,oHAA8G;AAyD7G,6GAzDQ,8DAA4B,OAyDR;AAvD7B,2HAAqH;AAyDpH,6GAzDQ,8DAA4B,OAyDR;AAtD7B,wHAAmH;AA2DlH,6GA3DQ,6DAA4B,OA2DR;AAzD7B,iIAA2H;AA2D1H,+GA3DQ,kEAA8B,OA2DR;AAzD/B,kHAA4G;AA2D3G,0GA3DQ,wDAAyB,OA2DR;AAzD1B,kHAA4G;AA2D3G,0GA3DQ,wDAAyB,OA2DR;AA1D1B,yDAAqD;AA2DpD,2FA3DQ,wBAAU,OA2DR;AAzDX,qDAAiD;AA2DhD,4FA3DQ,0BAAW,OA2DR"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,kFAA4E;AA6D3E,oGA7DQ,2CAAmB,OA6DR;AA5DpB,wEAAmE;AA6DlE,gGA7DQ,kCAAe,OA6DR;AA5DhB,0FAAoF;AA6DnF,wGA7DQ,mDAAuB,OA6DR;AA5DxB,8EAAwE;AA6DvE,kGA7DQ,uCAAiB,OA6DR;AA5DlB,wGAAiG;AA6DhG,8GA7DQ,gEAA6B,OA6DR;AA7C9B,6FAAwF;AA0DvF,oGA1DQ,2CAAmB,OA0DR;AAnDpB,sGAAiG;AA0DhG,uGA1DQ,iDAAsB,OA0DR;AApDvB,sGAAiG;AAwDhG,uGAxDQ,iDAAsB,OAwDR;AArDvB,+GAA0G;AA2DzG,0GA3DQ,uDAAyB,OA2DR;AAzD1B,uHAAgH;AA2D/G,6GA3DQ,+DAA4B,OA2DR;AAzD7B,qHAA+G;AA2D9G,2GA3DQ,0DAA0B,OA2DR;AAzD3B,oHAA8G;AA2D7G,6GA3DQ,8DAA4B,OA2DR;AAzD7B,2HAAqH;AA2DpH,6GA3DQ,8DAA4B,OA2DR;AAxD7B,wHAAmH;AA6DlH,6GA7DQ,6DAA4B,OA6DR;AA3D7B,iIAA2H;AA6D1H,+GA7DQ,kEAA8B,OA6DR;AA3D/B,kHAA4G;AA6D3G,0GA7DQ,wDAAyB,OA6DR;AA3D1B,kHAA4G;AA6D3G,0GA7DQ,wDAAyB,OA6DR;AA3D1B,4GAAsG;AA6DrG,wGA7DQ,oDAAuB,OA6DR;AA5DxB,yDAAqD;AA6DpD,2FA7DQ,wBAAU,OA6DR;AA3DX,qDAAiD;AA6DhD,4FA7DQ,0BAAW,OA6DR"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@studyportals/domain-client",
-  "version": "3.10.0",
+  "version": "3.11.0",
   "description": "Responsible for fetching data from the Domain API",
   "main": "bin/index.js",
   "author": "StudyPortals B.V.",

package/src/models/programme-card/i-programme-card.d.ts

@@ -1,5 +1,12 @@
 import { ICover, IDuration, IInternalLink, ILink, ILocation, ILogo, ITiming, ITrackedLink, ITracking, ITuitionFee } from "../../..";
 export interface IProgrammeCard {
+    /**
+     * ISO code of the country the programme is taught.
+     * Formatted in UPPERCASE
+     *
+     * @return string | null
+     */
+    getCountryIsoCode(): string | null;
     /**
      * Get the Cover of the programme if available.
      *
@@ -40,6 +47,7 @@ export interface IProgrammeCard {
      * @return ILocation
      */
     getLocation(): ILocation;
+    canShowLocation(): boolean;
     /**
      * Get the location text the programme is located in
      *

package/src/models/sitemap-cities-info/i-sitemap-city-info.d.ts

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

package/src/models/sitemap-cities-info/i-sitemap-city-info.js

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

package/src/models/sitemap-cities-info/i-sitemap-city-info.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-sitemap-city-info.js","sourceRoot":"","sources":["../../../../src/models/sitemap-cities-info/i-sitemap-city-info.ts"],"names":[],"mappings":""}

package/src/models/sitemap-cities-info/sitemap-cities-info-client.d.ts

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

package/src/models/sitemap-cities-info/sitemap-cities-info-client.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SitemapCitiesInfoClient = void 0;
+const model_client_1 = require("../../model-client");
+class SitemapCitiesInfoClient extends model_client_1.ModelClient {
+    getModelName() {
+        return 'sitemap-cities-info';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}
+exports.SitemapCitiesInfoClient = SitemapCitiesInfoClient;
+//# sourceMappingURL=sitemap-cities-info-client.js.map

package/src/models/sitemap-cities-info/sitemap-cities-info-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sitemap-cities-info-client.js","sourceRoot":"","sources":["../../../../src/models/sitemap-cities-info/sitemap-cities-info-client.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AAEjD,MAAa,uBAAwB,SAAQ,0BAA6B;IAC/D,YAAY;QACrB,OAAO,qBAAqB,CAAC;IAC9B,CAAC;IAES,UAAU;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,OAAO,KAAK,CAAC;IACd,CAAC;CACD;AAZD,0DAYC"}

package/src/types/portal-map.d.ts

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

package/src/types.d.ts

@@ -1,4 +1,4 @@
-export declare type Model = Record<string, Callable>;
-export declare type Callable = () => CallableReturnType | CallableReturnType[];
-export declare type CallableReturnType = AcceptedType | Model;
-export declare type AcceptedType = string | string[] | number | number[] | boolean | null | Date;
+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;