@studyportals/fawkes 8.2.4-15 → 8.2.4-17

package/dist/src/common/IPresenter.d.ts

@@ -3,4 +3,5 @@ import { FilterKey } from '@studyportals/search-filters/server-side';
 export interface IPresenter {
     readonly filterKey: FilterKey;
     getFragments(): IFragment[];
+    getFragmentsAsync?(): Promise<IFragment[]>;
 }

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,7 @@
 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 { RankedCountryCity } from './policies/ranked/RankedCountryCity';
+import { RankedCountryAreaCity } from './policies/ranked/RankedCountryAreaCity';
 export class SearchIndexabilityManager {
     policies;
     constructor(portalType, seoInfoBase, filterState, sortingState, applicationState) {
@@ -28,6 +30,8 @@ export class SearchIndexabilityManager {
             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/dist/src/organisations/policies/our-picks/CountryAreaCity.js

@@ -18,13 +18,10 @@ export class CountryAreaCity extends OrganisationsSeoIndexabilityPolicy {
     async generateUrls() {
         const cityFragments = await CityPresenter
             .getInstance(this.dependencies.searchApiClient)
-            .getFragments();
+            .getFragmentsAsync();
         const paths = [];
         console.warn(`Total city fragments fetched: ${cityFragments.length}`);
-        console.warn('Fetched city fragments for CountryAreaCity policy:', JSON.stringify(cityFragments));
         const filteredFragmentsForCountryAreaCity = cityFragments.filter(city => city.areaId !== null && city.areaId !== undefined);
-        console.warn(`Filtered down to ${filteredFragmentsForCountryAreaCity.length} city fragments for CountryAreaCity policy.`);
-        console.warn('Filtered city fragments for CountryAreaCity policy:', JSON.stringify(filteredFragmentsForCountryAreaCity));
         for (const city of filteredFragmentsForCountryAreaCity) {
             const areaId = city.areaId?.toString() || '';
             if (areaId === '') {
@@ -40,8 +37,6 @@ export class CountryAreaCity extends OrganisationsSeoIndexabilityPolicy {
                 paths.push(this.getPathWithSortingOption(city.path));
             }
         }
-        console.warn(`Generated ${paths.length} URLs for CountryAreaCity policy.`);
-        console.warn('Generated URLs:', JSON.stringify(paths));
         return paths;
     }
     get filterCombination() {

package/dist/src/organisations/policies/our-picks/CountryCity.js

@@ -17,13 +17,9 @@ export class CountryCity extends OrganisationsSeoIndexabilityPolicy {
     async generateUrls() {
         const cityFragments = await CityPresenter
             .getInstance(this.dependencies.searchApiClient)
-            .getFragments();
+            .getFragmentsAsync();
         const paths = [];
-        console.warn(`Total city fragments fetched: ${cityFragments.length}`);
-        console.warn('Fetched city fragments for CountryCity policy:', JSON.stringify(cityFragments));
         const filteredFragmentsForCountryCity = cityFragments.filter(city => city.areaId === null || city.areaId === undefined);
-        console.warn(`Filtered down to ${filteredFragmentsForCountryCity.length} city fragments for CountryCity policy.`);
-        console.warn('Filtered city fragments for CountryCity policy:', JSON.stringify(filteredFragmentsForCountryCity));
         for (const city of filteredFragmentsForCountryCity) {
             const filterKeyValues = new Map([
                 [FilterKey.CITY, [city.id]],
@@ -34,8 +30,6 @@ export class CountryCity extends OrganisationsSeoIndexabilityPolicy {
                 paths.push(this.getPathWithSortingOption(city.path));
             }
         }
-        console.warn(`Generated ${paths.length} URLs for CountryCity policy.`);
-        console.warn('Generated URLs:', JSON.stringify(paths));
         return paths;
     }
     get filterCombination() {

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

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

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

@@ -0,0 +1,42 @@
+import { OnlyFiltersSelectedRule } from "../../../common/rules/OnlyFiltersSelectedRule";
+import { SingleValueSelectedForFilterRule } from "../../../common/rules/SingleValueSelectedForFilterRule";
+import { FilterKey } from "@studyportals/search-filters/server-side";
+import { RankedOrganisationsSeoIndexabilityPolicy } from "../RankedOrganisationsSeoIndexabilityPolicy";
+import { FilterCombinations } from '../../../enums/FilterCombinations';
+import { CityPresenter } from "../../../presenters/CityPresenter";
+export class RankedCountryAreaCity extends RankedOrganisationsSeoIndexabilityPolicy {
+    name = 'Ranked Country Area City Policy';
+    description = 'Manages indexability of ranking-sorted country and area-specific city pages, applying rules to prioritize regions where quality-based sorting adds search value.';
+    baseRules = [
+        new SingleValueSelectedForFilterRule(FilterKey.CITY),
+        new SingleValueSelectedForFilterRule(FilterKey.COUNTRY),
+        new OnlyFiltersSelectedRule([FilterKey.CITY, FilterKey.COUNTRY])
+    ];
+    async generateUrls() {
+        const cityFragments = await CityPresenter
+            .getInstance(this.dependencies.searchApiClient)
+            .getFragmentsAsync();
+        const paths = [];
+        console.warn(`Total city fragments fetched: ${cityFragments.length}`);
+        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,11 @@
+import { OnlyFiltersSelectedRule } from "../../../common/rules/OnlyFiltersSelectedRule";
+import { SingleValueSelectedForFilterRule } from "../../../common/rules/SingleValueSelectedForFilterRule";
+import { RankedOrganisationsSeoIndexabilityPolicy } from "../RankedOrganisationsSeoIndexabilityPolicy";
+import { FilterCombinations } from '../../../enums/FilterCombinations';
+export declare class RankedCountryCity extends RankedOrganisationsSeoIndexabilityPolicy {
+    readonly name: string;
+    readonly description: string;
+    protected readonly baseRules: (SingleValueSelectedForFilterRule | OnlyFiltersSelectedRule)[];
+    protected generateUrls(): Promise<string[]>;
+    get filterCombination(): FilterCombinations;
+}

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

@@ -0,0 +1,36 @@
+import { OnlyFiltersSelectedRule } from "../../../common/rules/OnlyFiltersSelectedRule";
+import { SingleValueSelectedForFilterRule } from "../../../common/rules/SingleValueSelectedForFilterRule";
+import { FilterKey } from "@studyportals/search-filters/server-side";
+import { RankedOrganisationsSeoIndexabilityPolicy } from "../RankedOrganisationsSeoIndexabilityPolicy";
+import { FilterCombinations } from '../../../enums/FilterCombinations';
+import { CityPresenter } from "../../../presenters/CityPresenter";
+export class RankedCountryCity extends RankedOrganisationsSeoIndexabilityPolicy {
+    name = 'Ranked Country City Policy';
+    description = 'Manages indexability of ranking-sorted country and city-specific pages, applying rules to prioritize regions where quality-based sorting adds search value.';
+    baseRules = [
+        new SingleValueSelectedForFilterRule(FilterKey.CITY),
+        new SingleValueSelectedForFilterRule(FilterKey.COUNTRY),
+        new OnlyFiltersSelectedRule([FilterKey.CITY, FilterKey.COUNTRY])
+    ];
+    async generateUrls() {
+        const cityFragments = await CityPresenter
+            .getInstance(this.dependencies.searchApiClient)
+            .getFragmentsAsync();
+        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/presenters/CityPresenter.d.ts

@@ -1,14 +1,15 @@
 import { FilterKey } from '@studyportals/search-filters/server-side';
 import { ICityFragment } from './fragments/ICityFragment';
-import { ISearchApiClient } from '../../sitemap-generator-seo';
-export declare class CityPresenter {
+import { IPresenter, ISearchApiClient } from '../../sitemap-generator-seo';
+export declare class CityPresenter implements IPresenter {
     readonly filterKey: FilterKey;
     private searchApiClient;
     private static instance;
     private constructor();
     private fragmentsPromise;
     static getInstance(searchApiClient: ISearchApiClient): CityPresenter;
-    getFragments(): Promise<ICityFragment[]>;
+    getFragments(): ICityFragment[];
+    getFragmentsAsync(): Promise<ICityFragment[]>;
     private fetchCities;
     private processCity;
 }

package/dist/src/presenters/CityPresenter.js

@@ -16,7 +16,10 @@ export class CityPresenter {
         }
         return CityPresenter.instance;
     }
-    async getFragments() {
+    getFragments() {
+        return [];
+    }
+    async getFragmentsAsync() {
         if (!this.fragmentsPromise) {
             this.fragmentsPromise = this.fetchCities();
         }

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

@@ -8,6 +8,9 @@ import { CountryPresenter } from '../presenters/CountryPresenter';
 import { DisciplinePresenter } from '../presenters/DisciplinePresenter';
 import { FilterKey } from '@studyportals/search-filters/server-side';
 import { CountryAreaCity } from '../organisations/policies/our-picks/CountryAreaCity';
+import { RankedCountryCity } from '../organisations/policies/ranked/RankedCountryCity';
+import { RankedCountryAreaCity } from '../organisations/policies/ranked/RankedCountryAreaCity';
+import { CityPresenter } from '../presenters/CityPresenter';
 export class OrganisationsSitemapUrlGeneratorManager extends BaseSitemapUrlGeneratorManager {
     portalType;
     policies;
@@ -38,6 +41,8 @@ export class OrganisationsSitemapUrlGeneratorManager extends BaseSitemapUrlGener
             new RankedAttendanceDiscipline(dependencies),
             new RankedContinent(dependencies),
             new RankedContinentAttendance(dependencies),
+            new RankedCountryCity(dependencies),
+            new RankedCountryAreaCity(dependencies),
             new RankedCountry(dependencies),
             new RankedCountryAttendance(dependencies),
             new RankedCountryDiscipline(dependencies),
@@ -49,6 +54,7 @@ export class OrganisationsSitemapUrlGeneratorManager extends BaseSitemapUrlGener
         this.presenters.set(FilterKey.CONTINENT, ContinentPresenter.getInstance());
         this.presenters.set(FilterKey.COUNTRY, CountryPresenter.getInstance());
         this.presenters.set(FilterKey.DISCIPLINES, DisciplinePresenter.getInstance());
+        this.presenters.set(FilterKey.CITY, CityPresenter.getInstance(searchApiClient));
         this.setFilterKeyValueCounts();
     }
 }

package/package.json

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