@studyportals/fawkes 8.5.2 → 8.5.3-1

package/dist/src/enums/FilterCombinations.d.ts

@@ -73,6 +73,8 @@ export declare enum FilterCombinations {
     RANKED_CONTINENT = "rankedContinent",
     RANKED_CONTINENT_ATTENDANCE = "rankedContinentAttendance",
     RANKED_COUNTRY = "rankedCountry",
+    RANKED_COUNTRY_CITY = "rankedCountryCity",
+    RANKED_COUNTRY_AREA_CITY = "rankedCountryAreaCity",
     RANKED_COUNTRY_ATTENDANCE = "rankedCountryAttendance",
     RANKED_DISCIPLINE_COUNTRY = "rankedDisciplineCountry",
     RANKED_DISCIPLINE = "rankedDiscipline",

package/dist/src/enums/FilterCombinations.js

@@ -74,6 +74,8 @@ export var FilterCombinations;
     FilterCombinations["RANKED_CONTINENT"] = "rankedContinent";
     FilterCombinations["RANKED_CONTINENT_ATTENDANCE"] = "rankedContinentAttendance";
     FilterCombinations["RANKED_COUNTRY"] = "rankedCountry";
+    FilterCombinations["RANKED_COUNTRY_CITY"] = "rankedCountryCity";
+    FilterCombinations["RANKED_COUNTRY_AREA_CITY"] = "rankedCountryAreaCity";
     FilterCombinations["RANKED_COUNTRY_ATTENDANCE"] = "rankedCountryAttendance";
     FilterCombinations["RANKED_DISCIPLINE_COUNTRY"] = "rankedDisciplineCountry";
     FilterCombinations["RANKED_DISCIPLINE"] = "rankedDiscipline";

package/dist/src/organisations/SearchIndexabilityManager.js

@@ -1,5 +1,5 @@
 import { DependencyTypes } from '../enums/DependencyTypes';
-import { Area, AreaAttendance, Attendance, Continent, Country, CountryAttendance, Unfiltered, RankedArea, RankedAreaDiscipline, RankedAttendance, RankedAttendanceDiscipline, RankedContinent, RankedContinentAttendance, RankedCountry, RankedCountryAttendance, RankedCountryDiscipline, RankedDiscipline, RankedUnfiltered, CountryCity, CountryAreaCity } from '../organisations/policies';
+import { Area, AreaAttendance, Attendance, Continent, Country, CountryAttendance, Unfiltered, RankedArea, RankedAreaDiscipline, RankedAttendance, RankedAttendanceDiscipline, RankedContinent, RankedContinentAttendance, RankedCountry, RankedCountryAttendance, RankedCountryDiscipline, RankedDiscipline, RankedUnfiltered, CountryCity, CountryAreaCity, RankedCountryCity, RankedCountryAreaCity } from '../organisations/policies';
 export class SearchIndexabilityManager {
     policies;
     constructor(portalType, seoInfoBase, filterState, sortingState, applicationState) {
@@ -31,6 +31,8 @@ export class SearchIndexabilityManager {
             new RankedCountryAttendance(dependencies),
             new RankedCountryDiscipline(dependencies),
             new RankedDiscipline(dependencies),
+            new RankedCountryCity(dependencies),
+            new RankedCountryAreaCity(dependencies),
             new RankedUnfiltered(dependencies)
         ];
     }

package/dist/src/organisations/policies/index.d.ts

@@ -18,3 +18,5 @@ export * from './ranked/RankedCountryAttendance';
 export * from './ranked/RankedCountryDiscipline';
 export * from './ranked/RankedDiscipline';
 export * from './ranked/RankedUnfiltered';
+export * from './ranked/RankedCountryCity';
+export * from './ranked/RankedCountryAreaCity';

package/dist/src/organisations/policies/index.js

@@ -18,3 +18,5 @@ export * from './ranked/RankedCountryAttendance';
 export * from './ranked/RankedCountryDiscipline';
 export * from './ranked/RankedDiscipline';
 export * from './ranked/RankedUnfiltered';
+export * from './ranked/RankedCountryCity';
+export * from './ranked/RankedCountryAreaCity';

package/dist/src/organisations/policies/ranked/RankedCountryAreaCity.d.ts

@@ -0,0 +1,13 @@
+import { RankedOrganisationsSeoIndexabilityPolicy } from "../RankedOrganisationsSeoIndexabilityPolicy";
+import { IOrganisationsSeoDependencies } from "../../../organisations/types/IOrganisationsSeoDependencies";
+import { OnlyFiltersSelectedRule } from "../../../common/rules/OnlyFiltersSelectedRule";
+import { SingleValueSelectedForFilterRule } from "../../../common/rules/SingleValueSelectedForFilterRule";
+import { FilterCombinations } from "../../../enums/FilterCombinations";
+export declare class RankedCountryAreaCity extends RankedOrganisationsSeoIndexabilityPolicy {
+    readonly name: string;
+    readonly description: string;
+    protected readonly baseRules: (SingleValueSelectedForFilterRule | OnlyFiltersSelectedRule)[];
+    constructor(dependencies: IOrganisationsSeoDependencies);
+    protected generateUrls(): Promise<string[]>;
+    get filterCombination(): FilterCombinations;
+}

package/dist/src/organisations/policies/ranked/RankedCountryAreaCity.js

@@ -0,0 +1,43 @@
+import { RankedOrganisationsSeoIndexabilityPolicy } from "../RankedOrganisationsSeoIndexabilityPolicy";
+import { OnlyFiltersSelectedRule } from "../../../common/rules/OnlyFiltersSelectedRule";
+import { FilterKey } from "@studyportals/search-filters/server-side";
+import { SingleValueSelectedForFilterRule } from "../../../common/rules/SingleValueSelectedForFilterRule";
+import { CityPresenter } from "../../../presenters/CityPresenter";
+import { FilterCombinations } from "../../../enums/FilterCombinations";
+export class RankedCountryAreaCity extends RankedOrganisationsSeoIndexabilityPolicy {
+    name = 'Ranked Country/Area/City Policy';
+    description = 'Regulates indexability of ranking-sorted country, area, and city-level filtered pages, prioritizing high-value geographic views with quality-based sorting.';
+    baseRules = [
+        new SingleValueSelectedForFilterRule(FilterKey.CONTINENT),
+        new OnlyFiltersSelectedRule([FilterKey.CONTINENT])
+    ];
+    constructor(dependencies) {
+        super(dependencies);
+    }
+    async generateUrls() {
+        const cityFragments = await CityPresenter
+            .getInstance(this.dependencies.searchApiClient)
+            .getFragments();
+        const paths = [];
+        const filteredFragmentsForCountryAreaCity = cityFragments.filter(city => city.areaId !== null && city.areaId !== undefined);
+        for (const city of filteredFragmentsForCountryAreaCity) {
+            const areaId = city.areaId?.toString() || '';
+            if (areaId === '') {
+                continue;
+            }
+            const filterKeyValues = new Map([
+                [FilterKey.CITY, [city.id]],
+                [FilterKey.AREA, [areaId]],
+                [FilterKey.COUNTRY, [city.countryId]]
+            ]);
+            const result = await this.checkRulesForSitemap(filterKeyValues);
+            if (result) {
+                paths.push(this.getPathWithSortingOption(city.path));
+            }
+        }
+        return paths;
+    }
+    get filterCombination() {
+        return FilterCombinations.RANKED_COUNTRY_AREA_CITY;
+    }
+}

package/dist/src/organisations/policies/ranked/RankedCountryCity.d.ts

@@ -0,0 +1,14 @@
+import { RankedOrganisationsSeoIndexabilityPolicy } from "../RankedOrganisationsSeoIndexabilityPolicy";
+import { IOrganisationsSeoDependencies } from "../../../organisations/types/IOrganisationsSeoDependencies";
+import { OnlyFiltersSelectedRule } from "../../../common/rules/OnlyFiltersSelectedRule";
+import { SingleValueSelectedForFilterRule } from "../../../common/rules/SingleValueSelectedForFilterRule";
+import { ExcludeByIdForCitiesRule } from "../../../organisations/rules/ExcludeByIdForCitiesRule";
+import { FilterCombinations } from "../../../enums/FilterCombinations";
+export declare class RankedCountryCity extends RankedOrganisationsSeoIndexabilityPolicy {
+    readonly name: string;
+    readonly description: string;
+    protected readonly baseRules: (SingleValueSelectedForFilterRule | OnlyFiltersSelectedRule | ExcludeByIdForCitiesRule)[];
+    constructor(dependencies: IOrganisationsSeoDependencies);
+    protected generateUrls(): Promise<string[]>;
+    get filterCombination(): FilterCombinations;
+}

package/dist/src/organisations/policies/ranked/RankedCountryCity.js

@@ -0,0 +1,41 @@
+import { RankedOrganisationsSeoIndexabilityPolicy } from "../RankedOrganisationsSeoIndexabilityPolicy";
+import { OnlyFiltersSelectedRule } from "../../../common/rules/OnlyFiltersSelectedRule";
+import { FilterKey } from "@studyportals/search-filters/server-side";
+import { SingleValueSelectedForFilterRule } from "../../../common/rules/SingleValueSelectedForFilterRule";
+import { ExcludeByIdForCitiesRule } from "../../../organisations/rules/ExcludeByIdForCitiesRule";
+import { CityPresenter } from "../../../presenters/CityPresenter";
+import { FilterCombinations } from "../../../enums/FilterCombinations";
+export class RankedCountryCity extends RankedOrganisationsSeoIndexabilityPolicy {
+    name = 'Ranked Country/City Policy';
+    description = 'Regulates indexability of ranking-sorted country, and city-level filtered pages, prioritizing high-value geographic views with quality-based sorting.';
+    baseRules = [
+        new SingleValueSelectedForFilterRule(FilterKey.CITY),
+        new SingleValueSelectedForFilterRule(FilterKey.COUNTRY),
+        new OnlyFiltersSelectedRule([FilterKey.CITY, FilterKey.COUNTRY]),
+        new ExcludeByIdForCitiesRule(FilterKey.CITY)
+    ];
+    constructor(dependencies) {
+        super(dependencies);
+    }
+    async generateUrls() {
+        const cityFragments = await CityPresenter
+            .getInstance(this.dependencies.searchApiClient)
+            .getFragments();
+        const paths = [];
+        const filteredFragmentsForCountryCity = cityFragments.filter(city => city.areaId === null || city.areaId === undefined);
+        for (const city of filteredFragmentsForCountryCity) {
+            const filterKeyValues = new Map([
+                [FilterKey.CITY, [city.id]],
+                [FilterKey.COUNTRY, [city.countryId]]
+            ]);
+            const result = await this.checkRulesForSitemap(filterKeyValues);
+            if (result) {
+                paths.push(this.getPathWithSortingOption(city.path));
+            }
+        }
+        return paths;
+    }
+    get filterCombination() {
+        return FilterCombinations.RANKED_COUNTRY_CITY;
+    }
+}

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, RankedAreaDiscipline, RankedAttendance, RankedAttendanceDiscipline, RankedContinent, RankedContinentAttendance, RankedCountry, RankedCountryAttendance, RankedCountryDiscipline, RankedDiscipline, RankedUnfiltered, Unfiltered, RankedCountryCity, RankedCountryAreaCity } from '../organisations/policies';
 import { AreaPresenter } from '../presenters/AreaPresenter';
 import { AttendancePresenter } from '../presenters/AttendancePresenter';
 import { ContinentPresenter } from '../presenters/ContinentPresenter';
@@ -39,6 +39,8 @@ export class OrganisationsSitemapUrlGeneratorManager extends BaseSitemapUrlGener
             new RankedContinent(dependencies),
             new RankedContinentAttendance(dependencies),
             new RankedCountry(dependencies),
+            new RankedCountryCity(dependencies),
+            new RankedCountryAreaCity(dependencies),
             new RankedCountryAttendance(dependencies),
             new RankedCountryDiscipline(dependencies),
             new RankedDiscipline(dependencies),

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@studyportals/fawkes",
-	"version": "8.5.2",
+	"version": "8.5.3-1",
 	"description": "A package to centralize SEO related logic for SBLP and Sitemap Generator.",
 	"files": [
 		"./dist"