@studyportals/domain-client 3.6.0 → 3.6.1-beta.2

package/index.d.ts

@@ -31,9 +31,13 @@ import { IDotDigitalProgramme } from "./src/models/dotdigital-programme/i-dot-di
 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 { 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";
+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 { IInternalLink } from "./src/models/common/i-internal-link";
 import { ILogo } from "./src/models/common/i-logo";
 import { ITuitionFee } from "./src/models/common/i-tuition-fee";
@@ -42,4 +46,5 @@ import { ICity } from "./src/models/common/i-city";
 import { ICountry } from "./src/models/common/i-country";
 import { PortalType } from "./src/types/portal-type";
 import { PortalMap } from "./src/types/portal-map";
-export { BadRequestException, ClientException, InternalServerException, NotFoundException, PropertyNotAvailableException, IInternalLink, ILogo, ITuitionFee, IEnglishRequirements, ICity, ICountry, ICover, ILink, IOptionalLink, ILocation, IClickTrackingData, ITracking, IDuration, IDeadline, IStartDate, ITiming, ITrackedLink, IProgrammeCard, ProgrammeCardClient, ITuitionValues, IPremiumValues, IOrganisationValues, IGeoTargetingConfiguration, IGeoTargetingValues, ISearchProjection, SearchProjectionClient, ILivingCost, IGPARequirement, IBestFitProgramme, BestfitProgrammeClient, IDotDigitalProgramme, DotdigitalProgrammeClient, ISearchCountryFaq, PublicSearchCountryFaqClient, IReview, IDotDigitalOrganisation, DotdigitalOrganisationClient, PortalMap, PortalType };
+import { ModelClient } from "./src/model-client";
+export { BadRequestException, ClientException, InternalServerException, NotFoundException, PropertyNotAvailableException, IInternalLink, ILogo, ITuitionFee, IEnglishRequirements, ICity, ICountry, ICover, ILink, IOptionalLink, ILocation, IClickTrackingData, ITracking, IDuration, IDeadline, IStartDate, ITiming, ITrackedLink, IProgrammeCard, ProgrammeCardClient, ITuitionValues, IPremiumValues, IOrganisationValues, IGeoTargetingConfiguration, IGeoTargetingValues, ISearchProjection, SearchProjectionClient, ILivingCost, IGPARequirement, IBestFitProgramme, BestfitProgrammeClient, IDotDigitalProgramme, DotdigitalProgrammeClient, ISearchCountryFaq, PublicSearchCountryFaqClient, ISearchDiscipline, PublicSearchDisciplineClient, IReview, IDotDigitalOrganisation, DotdigitalOrganisationClient, PortalMap, PortalType, ISitemapRankingsInfo, SitemapRankingsInfoClient, ModelClient };

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PortalType = exports.DotdigitalOrganisationClient = 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.SitemapRankingsInfoClient = exports.PortalType = 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");
@@ -21,8 +21,14 @@ const dotdigital_programme_client_1 = require("./src/models/dotdigital-programme
 Object.defineProperty(exports, "DotdigitalProgrammeClient", { enumerable: true, get: function () { return dotdigital_programme_client_1.DotdigitalProgrammeClient; } });
 const public_search_country_faq_client_1 = require("./src/models/search-country-faq/public-search-country-faq-client");
 Object.defineProperty(exports, "PublicSearchCountryFaqClient", { enumerable: true, get: function () { return public_search_country_faq_client_1.PublicSearchCountryFaqClient; } });
+const public_search_discipline_client_1 = require("./src/models/search-discipline/public-search-discipline-client");
+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_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;AAjC9B,6FAAwF;AAoDvF,oGApDQ,2CAAmB,OAoDR;AA7CpB,sGAAiG;AAoDhG,uGApDQ,iDAAsB,OAoDR;AAhDvB,sGAAiG;AAoDhG,uGApDQ,iDAAsB,OAoDR;AAlDvB,+GAA0G;AAoDzG,0GApDQ,uDAAyB,OAoDR;AAlD1B,uHAAgH;AAoD/G,6GApDQ,+DAA4B,OAoDR;AAjD7B,wHAAmH;AAoDlH,6GApDQ,6DAA4B,OAoDR;AA7C7B,yDAAoD;AA+CnD,2FA/CQ,wBAAU,OA+CR"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,kFAA4E;AAmD3E,oGAnDQ,2CAAmB,OAmDR;AAlDpB,wEAAmE;AAmDlE,gGAnDQ,kCAAe,OAmDR;AAlDhB,0FAAoF;AAmDnF,wGAnDQ,mDAAuB,OAmDR;AAlDxB,8EAAwE;AAmDvE,kGAnDQ,uCAAiB,OAmDR;AAlDlB,wGAAiG;AAmDhG,8GAnDQ,gEAA6B,OAmDR;AAtC9B,6FAAwF;AAyDvF,oGAzDQ,2CAAmB,OAyDR;AAlDpB,sGAAiG;AAyDhG,uGAzDQ,iDAAsB,OAyDR;AArDvB,sGAAiG;AAyDhG,uGAzDQ,iDAAsB,OAyDR;AAvDvB,+GAA0G;AAyDzG,0GAzDQ,uDAAyB,OAyDR;AAvD1B,uHAAgH;AAyD/G,6GAzDQ,+DAA4B,OAyDR;AAvD7B,oHAA8G;AAyD7G,6GAzDQ,8DAA4B,OAyDR;AAtD7B,wHAAmH;AAyDlH,6GAzDQ,6DAA4B,OAyDR;AAvD7B,kHAA4G;AA2D3G,0GA3DQ,wDAAyB,OA2DR;AApD1B,yDAAoD;AAkDnD,2FAlDQ,wBAAU,OAkDR;AAhDX,qDAAiD;AAmDhD,4FAnDQ,0BAAW,OAmDR"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@studyportals/domain-client",
-  "version": "3.6.0",
+  "version": "3.6.1-beta.2",
   "description": "Responsible for fetching data from the Domain API",
   "main": "bin/index.js",
   "author": "StudyPortals B.V.",
@@ -12,6 +12,7 @@
     "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 version prerelease --preid=beta && npm run prepare-dist && npm publish bin --tag beta",
@@ -30,16 +31,16 @@
   },
   "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.15",
-    "@types/node": "^16.11.68",
+    "@types/moxios": "^0.4.9",
+    "@types/node": "^14.14.8",
     "@types/reflect-metadata": "^0.1.0",
-    "@typescript-eslint/eslint-plugin": "^5.40.1",
-    "@typescript-eslint/parser": "^5.40.1",
-    "eslint": "^8.25.0",
-    "eslint-plugin-import": "^2.26.0",
+    "@typescript-eslint/eslint-plugin": "^4.8.1",
+    "@typescript-eslint/parser": "^4.8.1",
+    "eslint": "^7.13.0",
+    "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-mocha": "^10.1.0",
     "husky": "^4.3.0",
     "mocha": "^10.1.0",
@@ -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/search-discipline/i-search-discipline.d.ts

@@ -0,0 +1,26 @@
+export interface ISearchDiscipline {
+    /**
+     * @return string | null
+     */
+    getIcon(): string | null;
+    /**
+     * @return number
+     */
+    getId(): number;
+    /**
+     * @return string
+     */
+    getName(): string;
+    /**
+     * @return string | null
+     */
+    getOldVirtualPath(): string | null;
+    /**
+     * @return number | null
+     */
+    getParentId(): number | null;
+    /**
+     * @return string
+     */
+    getVirtualPath(): string;
+}

package/src/models/search-discipline/i-search-discipline.js

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

package/src/models/search-discipline/i-search-discipline.js.map

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

package/src/models/search-discipline/public-search-discipline-client.d.ts

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

package/src/models/search-discipline/public-search-discipline-client.js

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

package/src/models/search-discipline/public-search-discipline-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"public-search-discipline-client.js","sourceRoot":"","sources":["../../../../src/models/search-discipline/public-search-discipline-client.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AAEjD,MAAa,4BAA6B,SAAQ,0BAA8B;IACrE,YAAY;QACrB,OAAO,mBAAmB,CAAC;IAC5B,CAAC;IAES,UAAU;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,OAAO,IAAI,CAAC;IACb,CAAC;CACD;AAZD,oEAYC"}

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

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

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

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

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

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

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

@@ -0,0 +1,7 @@
+import { ISitemapRankingsInfo } from "../../..";
+import { ModelClient } from "../../model-client";
+export declare class SitemapRankingsInfoClient extends ModelClient<ISitemapRankingsInfo> {
+    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,0BAAiC;IACrE,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;