@studyportals/domain-client 3.7.0-0 → 3.7.0-beta.1

package/index.d.ts

@@ -27,19 +27,26 @@ import { IGeoTargetingValues } from "./src/models/search-projection/i-geo-target
 import { ISearchProjection } from "./src/models/search-projection/i-search-projection";
 import { SearchProjectionClient } from "./src/models/search-projection/search-projection-client";
 import { IEnglishRequirements } from "./src/models/bestfit-programme/i-english-requirements";
+import { ICity } from "./src/models/bestfit-programme/i-city";
 import { ILivingCost } from "./src/models/bestfit-programme/i-living-cost";
 import { IGPARequirement } from "./src/models/bestfit-programme/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 { ICountry } from "./src/models/dotdigital-programme/i-country";
 import { IDotDigitalProgramme } from "./src/models/dotdigital-programme/i-dot-digital-programme";
 import { DotdigitalProgrammeClient } from "./src/models/dotdigital-programme/dotdigital-programme-client";
 import { ISearchCountryFaq } from "./src/models/search-country-faq/i-search-country-faq";
 import { PublicSearchCountryFaqClient } from "./src/models/search-country-faq/public-search-country-faq-client";
 import { ISearchDiscipline } from "./src/models/search-discipline/i-search-discipline";
 import { PublicSearchDisciplineClient } from "./src/models/search-discipline/public-search-discipline-client";
-import { ICountry } from "./src/models/dotdigital-organisation/i-country";
-import { ICity } from "./src/models/dotdigital-organisation/i-city";
 import { IReview } from "./src/models/dotdigital-organisation/i-review";
 import { IDotDigitalOrganisation } from "./src/models/dotdigital-organisation/i-dot-digital-organisation";
 import { DotdigitalOrganisationClient } from "./src/models/dotdigital-organisation/dotdigital-organisation-client";
-export { BadRequestException, ClientException, InternalServerException, NotFoundException, PropertyNotAvailableException, IInternalLink, ILogo, ICover, ILink, IOptionalLink, ILocation, IClickTrackingData, ITracking, ITuitionFee, IDuration, IDeadline, IStartDate, ITiming, ITrackedLink, IProgrammeCard, ProgrammeCardClient, ITuitionValues, IPremiumValues, IOrganisationValues, IGeoTargetingConfiguration, IGeoTargetingValues, ISearchProjection, SearchProjectionClient, IEnglishRequirements, ILivingCost, IGPARequirement, IBestFitProgramme, BestfitProgrammeClient, IDotDigitalProgramme, DotdigitalProgrammeClient, ISearchCountryFaq, PublicSearchCountryFaqClient, ISearchDiscipline, PublicSearchDisciplineClient, ICountry, ICity, IReview, IDotDigitalOrganisation, DotdigitalOrganisationClient };
+import { ISitemapInfo } from "./src/models/sitemap-countries-info/i-sitemap-info";
+import { SitemapCountriesInfoClient } from "./src/models/sitemap-countries-info/sitemap-countries-info-client";
+import { SitemapDisciplinesInfoClient } from "./src/models/sitemap-disciplines-info/sitemap-disciplines-info-client";
+import { SitemapRankingsInfoClient } from "./src/models/sitemap-rankings-info/sitemap-rankings-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, ISearchDiscipline, PublicSearchDisciplineClient, ICountry, ICity, IReview, IDotDigitalOrganisation, DotdigitalOrganisationClient, ISitemapInfo, SitemapCountriesInfoClient, SitemapDisciplinesInfoClient, SitemapRankingsInfoClient, PortalType, PortalMap, ModelClient };

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DotdigitalOrganisationClient = exports.PublicSearchDisciplineClient = 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.SitemapRankingsInfoClient = exports.SitemapDisciplinesInfoClient = exports.SitemapCountriesInfoClient = exports.DotdigitalOrganisationClient = exports.PublicSearchDisciplineClient = 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");
@@ -25,4 +25,14 @@ const public_search_discipline_client_1 = require("./src/models/search-disciplin
 Object.defineProperty(exports, "PublicSearchDisciplineClient", { enumerable: true, get: function () { return public_search_discipline_client_1.PublicSearchDisciplineClient; } });
 const dotdigital_organisation_client_1 = require("./src/models/dotdigital-organisation/dotdigital-organisation-client");
 Object.defineProperty(exports, "DotdigitalOrganisationClient", { enumerable: true, get: function () { return dotdigital_organisation_client_1.DotdigitalOrganisationClient; } });
+const sitemap_countries_info_client_1 = require("./src/models/sitemap-countries-info/sitemap-countries-info-client");
+Object.defineProperty(exports, "SitemapCountriesInfoClient", { enumerable: true, get: function () { return sitemap_countries_info_client_1.SitemapCountriesInfoClient; } });
+const sitemap_disciplines_info_client_1 = require("./src/models/sitemap-disciplines-info/sitemap-disciplines-info-client");
+Object.defineProperty(exports, "SitemapDisciplinesInfoClient", { enumerable: true, get: function () { return sitemap_disciplines_info_client_1.SitemapDisciplinesInfoClient; } });
+const sitemap_rankings_info_client_1 = require("./src/models/sitemap-rankings-info/sitemap-rankings-info-client");
+Object.defineProperty(exports, "SitemapRankingsInfoClient", { enumerable: true, get: function () { return sitemap_rankings_info_client_1.SitemapRankingsInfoClient; } });
+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");
+Object.defineProperty(exports, "ModelClient", { enumerable: true, get: function () { return model_client_1.ModelClient; } });
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,kFAA4E;AA8C3E,oGA9CQ,2CAAmB,OA8CR;AA7CpB,wEAAmE;AA8ClE,gGA9CQ,kCAAe,OA8CR;AA7ChB,0FAAoF;AA8CnF,wGA9CQ,mDAAuB,OA8CR;AA7CxB,8EAAwE;AA8CvE,kGA9CQ,uCAAiB,OA8CR;AA7ClB,wGAAiG;AA8ChG,8GA9CQ,gEAA6B,OA8CR;AA9B9B,6FAAwF;AA8CvF,oGA9CQ,2CAAmB,OA8CR;AAvCpB,sGAAiG;AA8ChG,uGA9CQ,iDAAsB,OA8CR;AAzCvB,sGAAiG;AA8ChG,uGA9CQ,iDAAsB,OA8CR;AA5CvB,+GAA0G;AA8CzG,0GA9CQ,uDAAyB,OA8CR;AA5C1B,uHAAgH;AA8C/G,6GA9CQ,+DAA4B,OA8CR;AA5C7B,oHAA8G;AA8C7G,6GA9CQ,8DAA4B,OA8CR;AAzC7B,wHAAmH;AA8ClH,6GA9CQ,6DAA4B,OA8CR"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,kFAA4E;AAqD3E,oGArDQ,2CAAmB,OAqDR;AApDpB,wEAAmE;AAqDlE,gGArDQ,kCAAe,OAqDR;AApDhB,0FAAoF;AAqDnF,wGArDQ,mDAAuB,OAqDR;AApDxB,8EAAwE;AAqDvE,kGArDQ,uCAAiB,OAqDR;AApDlB,wGAAiG;AAqDhG,8GArDQ,gEAA6B,OAqDR;AArC9B,6FAAwF;AAkDvF,oGAlDQ,2CAAmB,OAkDR;AA3CpB,sGAAiG;AAkDhG,uGAlDQ,iDAAsB,OAkDR;AA5CvB,sGAAiG;AAgDhG,uGAhDQ,iDAAsB,OAgDR;AA7CvB,+GAA0G;AAmDzG,0GAnDQ,uDAAyB,OAmDR;AAjD1B,uHAAgH;AAmD/G,6GAnDQ,+DAA4B,OAmDR;AAjD7B,oHAA8G;AAmD7G,6GAnDQ,8DAA4B,OAmDR;AAhD7B,wHAAmH;AAqDlH,6GArDQ,6DAA4B,OAqDR;AAnD7B,qHAA+G;AAqD9G,2GArDQ,0DAA0B,OAqDR;AApD3B,2HAAqH;AAqDpH,6GArDQ,8DAA4B,OAqDR;AApD7B,kHAA4G;AAqD3G,0GArDQ,wDAAyB,OAqDR;AApD1B,yDAAqD;AAqDpD,2FArDQ,wBAAU,OAqDR;AAnDX,qDAAiD;AAqDhD,4FArDQ,0BAAW,OAqDR"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@studyportals/domain-client",
-  "version": "3.7.0-0",
+  "version": "3.7.0-beta.1",
   "description": "Responsible for fetching data from the Domain API",
   "main": "bin/index.js",
   "author": "StudyPortals B.V.",
@@ -12,9 +12,10 @@
     "test": "mocha --reporter spec \"tests/**/*.test.ts\"",
     "coverage": "nyc mocha --reporter dot \"tests/**/*.test.ts\"",
     "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-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",
@@ -30,7 +31,7 @@
   },
   "devDependencies": {
     "@studyportals/code-style": "^1.8.1",
-    "@testdeck/mocha": "^0.2.1",
+    "@testdeck/mocha": "^0.3.3",
     "@types/axios": "^0.14.0",
     "@types/mocha": "^10.0.0",
     "@types/moxios": "^0.4.9",
@@ -49,6 +50,6 @@
     "ts-node": "^10.9.1",
     "tslint": "^6.1.3",
     "typemoq": "^2.1.0",
-    "typescript": "^4.8.4"
+    "typescript": "^4.9.3"
   }
 }

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

@@ -98,6 +98,7 @@ export interface IProgrammeCard {
     getTracking(): ITracking;
     /**
      * Get all tuition fees of the programme.
+     *
      * @return ITuitionFee[]
      */
     getTuitionFees(): ITuitionFee[];

package/src/models/sitemap-countries-info/i-sitemap-info.d.ts

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

package/src/models/sitemap-countries-info/i-sitemap-info.js

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

package/src/models/sitemap-countries-info/i-sitemap-info.js.map

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

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

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

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"sitemap-countries-info-client.js","sourceRoot":"","sources":["../../../../src/models/sitemap-countries-info/sitemap-countries-info-client.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AAEjD,MAAa,0BAA2B,SAAQ,0BAAyB;IAC9D,YAAY;QACrB,OAAO,wBAAwB,CAAC;IACjC,CAAC;IAES,UAAU;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,OAAO,KAAK,CAAC;IACd,CAAC;CACD;AAZD,gEAYC"}

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

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

package/src/models/sitemap-disciplines-info/i-sitemap-info.js

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

package/src/models/sitemap-disciplines-info/i-sitemap-info.js.map

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

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

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

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"sitemap-disciplines-info-client.js","sourceRoot":"","sources":["../../../../src/models/sitemap-disciplines-info/sitemap-disciplines-info-client.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AAEjD,MAAa,4BAA6B,SAAQ,0BAAyB;IAChE,YAAY;QACrB,OAAO,0BAA0B,CAAC;IACnC,CAAC;IAES,UAAU;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,OAAO,KAAK,CAAC;IACd,CAAC;CACD;AAZD,oEAYC"}

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

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

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

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

package/src/models/sitemap-rankings-info/i-sitemap-info.js.map

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

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

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

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"sitemap-rankings-info-client.js","sourceRoot":"","sources":["../../../../src/models/sitemap-rankings-info/sitemap-rankings-info-client.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AAEjD,MAAa,yBAA0B,SAAQ,0BAAyB;IAC7D,YAAY;QACrB,OAAO,uBAAuB,CAAC;IAChC,CAAC;IAES,UAAU;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,OAAO,KAAK,CAAC;IACd,CAAC;CACD;AAZD,8DAYC"}

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;