@studyportals/fawkes 8.7.2 → 9.0.1-0

package/dist/src/scholarships/rules/OnlyCountriesDisciplineCountryRule.d.ts

@@ -0,0 +1,13 @@
+import { IRule } from "../../common/IRule";
+import { ISearchDependencies } from "../../common/ISearchDependencies";
+import { FilterKeyValuesMap } from "../../../sitemap-generator-seo";
+export declare class OnlyCountriesDisciplineCountryRule implements IRule {
+    private readonly countryFilterKey;
+    private readonly allowedCountryIsos;
+    private allowedCountryIds?;
+    getName(): string;
+    forSearch(dependencies: ISearchDependencies): Promise<boolean>;
+    forSitemapGenerator(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
+    private getAllowedCountryIds;
+    getDescription(): string;
+}

package/dist/src/scholarships/rules/OnlyCountriesDisciplineCountryRule.js

@@ -0,0 +1,40 @@
+import { FilterKey } from "@studyportals/search-filters/server-side";
+import { CountryPresenter } from "../../presenters/CountryPresenter";
+export class OnlyCountriesDisciplineCountryRule {
+    countryFilterKey = FilterKey.COUNTRY;
+    allowedCountryIsos = ['AU', 'CA', 'CN', 'FR', 'DE', 'IN', 'IE', 'IT', 'JP', 'MY', 'NL', 'NZ', 'SG', 'KR', 'CH', 'GB', 'US'];
+    allowedCountryIds;
+    getName() {
+        return 'OnlyCountriesDisciplineCountryRule';
+    }
+    forSearch(dependencies) {
+        const selectedCountry = dependencies.seoInfoBase.getFilterOptionValueBy(this.countryFilterKey, dependencies.filterState);
+        if (!selectedCountry) {
+            return Promise.resolve(false);
+        }
+        return Promise.resolve(this.getAllowedCountryIds().has(selectedCountry));
+    }
+    forSitemapGenerator(filterKeyValues) {
+        const selectedCountries = filterKeyValues.get(FilterKey.COUNTRY);
+        if (!selectedCountries || selectedCountries.length !== 1) {
+            return Promise.resolve(false);
+        }
+        const selectedCountry = selectedCountries[0];
+        if (!selectedCountry) {
+            return Promise.resolve(false);
+        }
+        return Promise.resolve(this.getAllowedCountryIds().has(selectedCountry));
+    }
+    getAllowedCountryIds() {
+        if (!this.allowedCountryIds) {
+            this.allowedCountryIds = new Set(CountryPresenter.getInstance()
+                .getFragments()
+                .filter((country) => this.allowedCountryIsos.includes(country.iso))
+                .map((country) => country.id));
+        }
+        return this.allowedCountryIds;
+    }
+    getDescription() {
+        return 'Country is one of the allowed countries for discipline and country pages';
+    }
+}

package/dist/src/scholarships/types/IScholarshipSearchDependencies.d.ts

@@ -0,0 +1,5 @@
+import { ISearchDependencies } from '../../common/ISearchDependencies';
+import { PortalType } from '@studyportals/domain-client';
+export interface IScholarshipSearchDependencies extends ISearchDependencies {
+    portalType?: PortalType;
+}

package/dist/src/scholarships/types/IScholarshipSearchDependencies.js

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

package/dist/src/scholarships/types/IScholarshipSeoDependencies.d.ts

@@ -1,3 +1,3 @@
-import { ISearchDependencies } from '../../common/ISearchDependencies';
+import { IScholarshipSearchDependencies } from './IScholarshipSearchDependencies';
 import { IScholarshipSitemapDependencies } from './IScholarshipSitemapDependencies';
-export type IScholarshipSeoDependencies = ISearchDependencies | IScholarshipSitemapDependencies;
+export type IScholarshipSeoDependencies = IScholarshipSearchDependencies | IScholarshipSitemapDependencies;

package/dist/src/scholarships/types/IScholarshipSitemapDependencies.d.ts

@@ -1,5 +1,7 @@
 import { ISitemapDependencies } from '../../common/ISitemapDependencies';
 import { IOrganisationsClient } from '../../sitemap-generator/IOrganisationsClient';
+import { PortalType } from '@studyportals/domain-client';
 export interface IScholarshipSitemapDependencies extends ISitemapDependencies {
     organisationsClient: IOrganisationsClient;
+    portalType?: PortalType;
 }

package/dist/src/sitemap-generator/ISearchApiClient.d.ts

@@ -11,4 +11,5 @@ export interface ISearchApiClient {
     }[]>;
     getProgrammeCount?(filterKeyValues: FilterKeyValuesMap): Promise<number>;
     getCount(filterKeyValues: FilterKeyValuesMap): Promise<number>;
+    getCountWithRankings?(filterKeyValues: FilterKeyValuesMap): Promise<number>;
 }

package/dist/src/sitemap-generator/OrganisationsSitemapUrlGeneratorManager.d.ts

@@ -3,12 +3,11 @@ import { IOrganisationsClient } from '../sitemap-generator/IOrganisationsClient'
 import { ISearchApiClient } from '../sitemap-generator/ISearchApiClient';
 import { BaseSitemapUrlGeneratorManager } from './BaseSitemapUrlGeneratorManager';
 import { PortalType } from '@studyportals/domain-client';
-import { IRankingApiClient } from './IRankingApiClient';
 import { FilterKey } from '@studyportals/search-filters/server-side';
 import { IPresenter } from '../common';
 export declare class OrganisationsSitemapUrlGeneratorManager extends BaseSitemapUrlGeneratorManager {
     readonly portalType: PortalType;
     readonly policies: ISitemapUrlGenerator[];
     readonly presenters: Map<FilterKey, IPresenter>;
-    constructor(portalType: PortalType, searchApiClient: ISearchApiClient, organisationsClient: IOrganisationsClient, rankingApiClient: IRankingApiClient);
+    constructor(portalType: PortalType, searchApiClient: ISearchApiClient, organisationsClient: IOrganisationsClient);
 }

package/dist/src/sitemap-generator/OrganisationsSitemapUrlGeneratorManager.js

@@ -1,6 +1,6 @@
 import { DependencyTypes } from '../enums/DependencyTypes';
 import { BaseSitemapUrlGeneratorManager } from './BaseSitemapUrlGeneratorManager';
-import { Area, AreaAttendance, Attendance, Continent, Country, CountryCity, CountryAttendance, RankedArea, RankedAreaDiscipline, RankedAttendance, RankedAttendanceDiscipline, RankedContinent, RankedContinentAttendance, RankedCountry, RankedCountryAttendance, RankedCountryDiscipline, RankedDiscipline, RankedUnfiltered, Unfiltered } from '../organisations/policies';
+import { Area, AreaAttendance, Attendance, Continent, Country, CountryCity, CountryAttendance, RankedArea, RankedAttendance, RankedAttendanceDiscipline, RankedContinent, RankedContinentAttendance, RankedCountry, RankedCountryAttendance, RankedCountryDiscipline, RankedDiscipline, RankedUnfiltered, Unfiltered } from '../organisations/policies';
 import { AreaPresenter } from '../presenters/AreaPresenter';
 import { AttendancePresenter } from '../presenters/AttendancePresenter';
 import { ContinentPresenter } from '../presenters/ContinentPresenter';
@@ -12,7 +12,7 @@ export class OrganisationsSitemapUrlGeneratorManager extends BaseSitemapUrlGener
     portalType;
     policies;
     presenters = new Map();
-    constructor(portalType, searchApiClient, organisationsClient, rankingApiClient) {
+    constructor(portalType, searchApiClient, organisationsClient) {
         super();
         this.portalType = portalType;
         const dependencies = {
@@ -20,7 +20,6 @@ export class OrganisationsSitemapUrlGeneratorManager extends BaseSitemapUrlGener
             portalType,
             searchApiClient,
             organisationsClient,
-            rankingApiClient
         };
         this.policies = [
             new CountryCity(dependencies),
@@ -33,7 +32,6 @@ export class OrganisationsSitemapUrlGeneratorManager extends BaseSitemapUrlGener
             new CountryAttendance(dependencies),
             new Unfiltered(dependencies),
             new RankedArea(dependencies),
-            new RankedAreaDiscipline(dependencies),
             new RankedAttendance(dependencies),
             new RankedAttendanceDiscipline(dependencies),
             new RankedContinent(dependencies),

package/dist/src/sitemap-generator/ScholarshipsSitemapUrlGeneratorManager.d.ts

@@ -1,9 +1,10 @@
 import { ISitemapUrlGenerator } from '../common/ISitemapUrlGenerator';
 import { IOrganisationsClient } from '../sitemap-generator/IOrganisationsClient';
 import { ISearchApiClient } from '../sitemap-generator/ISearchApiClient';
+import { PortalType } from '@studyportals/domain-client';
 import { BaseSitemapUrlGeneratorManager } from './BaseSitemapUrlGeneratorManager';
 export declare class ScholarshipsSitemapUrlGeneratorManager extends BaseSitemapUrlGeneratorManager {
     readonly policies: ISitemapUrlGenerator[];
     readonly presenters: Map<any, any>;
-    constructor(searchApiClient: ISearchApiClient, organisationsClient: IOrganisationsClient);
+    constructor(searchApiClient: ISearchApiClient, organisationsClient: IOrganisationsClient, portalType?: PortalType);
 }

package/dist/src/sitemap-generator/ScholarshipsSitemapUrlGeneratorManager.js

@@ -9,12 +9,13 @@ import { BaseSitemapUrlGeneratorManager } from './BaseSitemapUrlGeneratorManager
 export class ScholarshipsSitemapUrlGeneratorManager extends BaseSitemapUrlGeneratorManager {
     policies;
     presenters = new Map();
-    constructor(searchApiClient, organisationsClient) {
+    constructor(searchApiClient, organisationsClient, portalType) {
         super();
         const dependencies = {
             dependencyType: DependencyTypes.SITEMAP_GENERATOR,
             searchApiClient,
-            organisationsClient
+            organisationsClient,
+            portalType
         };
         this.policies = [
             new Area(dependencies),

package/package.json

@@ -1,105 +1,106 @@
-{
-	"name": "@studyportals/fawkes",
-	"version": "8.7.2",
-	"description": "A package to centralize SEO related logic for SBLP and Sitemap Generator.",
-	"files": [
-		"./dist"
-	],
-	"scripts": {
-		"prepush": "npm run test",
-		"precommit": "npm run lint",
-		"compile": "npx tsc && tsc-alias && rm -r ./dist/tests",
-		"build": "npm run clean && npm run compile",
-		"clean": "rimraf \"!(node_modules)/**/dist\"",
-		"prepare-deployment": "npm run test && npm run build",
-		"publish-major": "npm run prepare-deployment && npm version major && npm publish",
-		"publish-beta": "npm run prepare-deployment && npm version prerelease && npm publish --tag beta --access=public",
-		"publish-patch": "npm run prepare-deployment && npm version patch && npm publish",
-		"publish-minor": "npm run prepare-deployment && npm version minor && npm publish",
-		"prepare": "husky install",
-		"test": "vitest run --coverage",
-		"test:dev": "vitest --coverage tests/programmes",
-		"lint": "eslint . --ext .ts",
-		"lint:fix": "eslint . --ext .ts --fix",
-		"prettier:fix": "npx prettier --use-tabs --ignore-path .gitignore --write ."
-	},
-	"exports": {
-		"./organisations-search-seo": {
-			"import": "./dist/organisations-seo/index.js",
-			"require": "./dist/organisations-seo/index.js",
-			"types": "./dist/organisations-seo/index.d.ts"
-		},
-		"./programmes-search-seo": {
-			"import": "./dist/programmes-seo/index.js",
-			"require": "./dist/programmes-seo/index.js",
-			"types": "./dist/programmes-seo/index.d.ts"
-		},
-		"./scholarships-search-seo": {
-			"import": "./dist/scholarships-seo/index.js",
-			"require": "./dist/scholarships-seo/index.js",
-			"types": "./dist/scholarships-seo/index.d.ts"
-		},
-		"./sitemap-generator-seo": {
-			"import": "./dist/sitemap-generator-seo/index.js",
-			"require": "./dist/sitemap-generator-seo/index.js",
-			"types": "./dist/sitemap-generator-seo/index.d.ts"
-		},
-		"./structured-data-seo": {
-			"import": "./dist/structured-data-seo/index.js",
-			"require": "./dist/structured-data-seo/index.js",
-			"types": "./dist/structured-data-seo/index.d.ts"
-		}
-	},
-	"typesVersions": {
-		"*": {
-			"organisations-search-seo": [
-				"dist/organisations-seo/index.d.ts"
-			],
-			"programmes-search-seo": [
-				"dist/programmes-seo/index.d.ts"
-			],
-			"scholarships-search-seo": [
-				"dist/scholarships-seo/index.d.ts"
-			],
-			"sitemap-generator-seo": [
-				"dist/sitemap-generator-seo/index.d.ts"
-			],
-			"structured-data-seo": [
-				"dist/structured-data-seo/index.d.ts"
-			],
-			"*": [
-				"dist/index.d.ts"
-			]
-		}
-	},
-	"author": "The Jedi Council",
-	"license": "ISC",
-	"devDependencies": {
-		"@adobe/structured-data-validator": "^1.4.1",
-		"@studyportals/code-style": "^2.2.1",
-		"@studyportals/webpack-helper": "^6.0.6",
-		"@vitest/coverage-istanbul": "^2.1.8",
-		"husky": "^8.0.3",
-		"jsdom": "^26.0.0",
-		"prettier": "^3.5.3",
-		"schema-dts": "^1.1.5",
-		"ts-loader": "^9.5.2",
-		"tsc-alias": "^1.8.11",
-		"typemoq": "^2.1.0",
-		"typescript": "^5.7.3",
-		"vitest": "^2.1.8"
-	},
-	"dependencies": {
-		"@studyportals/domain-client": "^8.2.0",
-		"@studyportals/ranking-api-interface": "^1.3.12",
-		"@studyportals/search-filters": "^6.3.1",
-		"@studyportals/static-domain-data": "^6.1.0"
-	},
-	"optionalDependencies": {
-		"@rollup/rollup-linux-x64-gnu": "4.24.0"
-	},
-	"engines": {
-		"node": ">=18 <=24",
-		"npm": ">=8 <=11"
-	}
-}
+{
+	"name": "@studyportals/fawkes",
+	"version": "9.0.1-0",
+	"description": "A package to centralize SEO related logic for SBLP and Sitemap Generator.",
+	"files": [
+		"./dist"
+	],
+	"scripts": {
+		"prepush": "npm run test",
+		"precommit": "npm run lint",
+		"compile": "npx tsc && tsc-alias && rm -r ./dist/tests",
+		"build": "npm run clean && npm run compile",
+		"clean": "rimraf \"!(node_modules)/**/dist\"",
+		"prepare-deployment": "npm run test && npm run build",
+		"publish-major": "npm run prepare-deployment && npm version major && npm publish",
+		"publish-beta": "npm run prepare-deployment && npm version prerelease && npm publish --tag beta --access=public",
+		"publish-patch": "npm run prepare-deployment && npm version patch && npm publish",
+		"publish-minor": "npm run prepare-deployment && npm version minor && npm publish",
+		"prepare": "husky install",
+		"test": "vitest run --coverage",
+		"test:dev": "vitest --coverage tests/programmes",
+		"lint": "eslint . --ext .ts",
+		"lint:fix": "eslint . --ext .ts --fix",
+		"prettier:fix": "npx prettier --use-tabs --ignore-path .gitignore --write ."
+	},
+	"exports": {
+		"./organisations-search-seo": {
+			"import": "./dist/organisations-seo/index.js",
+			"require": "./dist/organisations-seo/index.js",
+			"types": "./dist/organisations-seo/index.d.ts"
+		},
+		"./programmes-search-seo": {
+			"import": "./dist/programmes-seo/index.js",
+			"require": "./dist/programmes-seo/index.js",
+			"types": "./dist/programmes-seo/index.d.ts"
+		},
+		"./scholarships-search-seo": {
+			"import": "./dist/scholarships-seo/index.js",
+			"require": "./dist/scholarships-seo/index.js",
+			"types": "./dist/scholarships-seo/index.d.ts"
+		},
+		"./sitemap-generator-seo": {
+			"import": "./dist/sitemap-generator-seo/index.js",
+			"require": "./dist/sitemap-generator-seo/index.js",
+			"types": "./dist/sitemap-generator-seo/index.d.ts"
+		},
+		"./structured-data-seo": {
+			"import": "./dist/structured-data-seo/index.js",
+			"require": "./dist/structured-data-seo/index.js",
+			"types": "./dist/structured-data-seo/index.d.ts"
+		}
+	},
+	"typesVersions": {
+		"*": {
+			"organisations-search-seo": [
+				"dist/organisations-seo/index.d.ts"
+			],
+			"programmes-search-seo": [
+				"dist/programmes-seo/index.d.ts"
+			],
+			"scholarships-search-seo": [
+				"dist/scholarships-seo/index.d.ts"
+			],
+			"sitemap-generator-seo": [
+				"dist/sitemap-generator-seo/index.d.ts"
+			],
+			"structured-data-seo": [
+				"dist/structured-data-seo/index.d.ts"
+			],
+			"*": [
+				"dist/index.d.ts"
+			]
+		}
+	},
+	"author": "The Jedi Council",
+	"license": "ISC",
+	"devDependencies": {
+		"@adobe/structured-data-validator": "^1.4.1",
+		"@studyportals/code-style": "^2.2.1",
+		"@studyportals/webpack-helper": "^6.0.6",
+		"@vitest/coverage-istanbul": "^2.1.8",
+		"husky": "^8.0.3",
+		"jsdom": "^26.0.0",
+		"prettier": "^3.5.3",
+		"schema-dts": "^1.1.5",
+		"ts-loader": "^9.5.2",
+		"tsc-alias": "^1.8.11",
+		"typemoq": "^2.1.0",
+		"typescript": "^5.7.3",
+		"vitest": "^2.1.8"
+	},
+	"dependencies": {
+		"@studyportals/domain-client": "^8.1.0",
+		"@studyportals/ranking-api-interface": "^2.4.0",
+		"@studyportals/search-api-interface": "5.9.3-0",
+		"@studyportals/search-filters": "^6.3.1",
+		"@studyportals/static-domain-data": "^6.1.0"
+	},
+	"optionalDependencies": {
+		"@rollup/rollup-linux-x64-gnu": "4.24.0"
+	},
+	"engines": {
+		"node": ">=18 <=24",
+		"npm": ">=8 <=11"
+	}
+}