@studyportals/fawkes 8.2.4-0 → 8.2.4-10

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

@@ -2,5 +2,5 @@ import { IFragment } from '../presenters/fragments/IFragment';
 import { FilterKey } from '@studyportals/search-filters/server-side';
 export interface IPresenter {
     readonly filterKey: FilterKey;
-    getFragments(): IFragment[] | Promise<IFragment[]>;
+    getFragments(): IFragment[];
 }

package/dist/src/organisations/SearchIndexabilityManager.js

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

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

@@ -1,9 +1,10 @@
-export * from './our-picks/City';
 export * from './our-picks/Area';
 export * from './our-picks/AreaAttendance';
 export * from './our-picks/Attendance';
 export * from './our-picks/Continent';
 export * from './our-picks/Country';
+export * from './our-picks/CountryCity';
+export * from './our-picks/CountryAreaCity';
 export * from './our-picks/CountryAttendance';
 export * from './our-picks/Unfiltered';
 export * from './ranked/RankedArea';

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

@@ -1,9 +1,10 @@
-export * from './our-picks/City';
 export * from './our-picks/Area';
 export * from './our-picks/AreaAttendance';
 export * from './our-picks/Attendance';
 export * from './our-picks/Continent';
 export * from './our-picks/Country';
+export * from './our-picks/CountryCity';
+export * from './our-picks/CountryAreaCity';
 export * from './our-picks/CountryAttendance';
 export * from './our-picks/Unfiltered';
 export * from './ranked/RankedArea';

package/dist/src/organisations/policies/our-picks/CountryAreaCity.d.ts

@@ -0,0 +1,13 @@
+import { FilterCombinations } from '../../../enums/FilterCombinations';
+import { SortingOptions } from '../../../enums/SortingOptions';
+import { OrganisationsSeoIndexabilityPolicy } from '../../../organisations/policies/OrganisationsSeoIndexabilityPolicy';
+import { SingleValueSelectedForFilterRule } from '../../../common/rules/SingleValueSelectedForFilterRule';
+import { OnlyFiltersSelectedRule } from '../../../common/rules/OnlyFiltersSelectedRule';
+export declare class CountryAreaCity extends OrganisationsSeoIndexabilityPolicy {
+    readonly name: string;
+    readonly description: string;
+    protected readonly sortingOption = SortingOptions.OUR_PICKS;
+    protected readonly baseRules: (SingleValueSelectedForFilterRule | OnlyFiltersSelectedRule)[];
+    protected generateUrls(): Promise<string[]>;
+    get filterCombination(): FilterCombinations;
+}

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

@@ -0,0 +1,39 @@
+import { FilterCombinations } from '../../../enums/FilterCombinations';
+import { FilterKey } from '@studyportals/search-filters/server-side';
+import { SortingOptions } from '../../../enums/SortingOptions';
+import { OrganisationsSeoIndexabilityPolicy } from '../../../organisations/policies/OrganisationsSeoIndexabilityPolicy';
+import { SingleValueSelectedForFilterRule } from '../../../common/rules/SingleValueSelectedForFilterRule';
+import { OnlyFiltersSelectedRule } from '../../../common/rules/OnlyFiltersSelectedRule';
+import { CityPresenter } from '../../../presenters/CityPresenter';
+export class CountryAreaCity extends OrganisationsSeoIndexabilityPolicy {
+    name = 'Country Area City Policy';
+    description = 'Controls indexing of pages filtered by geographic cities and areas, ensuring only SEO-valuable regional content with sufficient search volume is indexed.';
+    sortingOption = SortingOptions.OUR_PICKS;
+    baseRules = [
+        new SingleValueSelectedForFilterRule(FilterKey.CITY),
+        new SingleValueSelectedForFilterRule(FilterKey.COUNTRY),
+        new SingleValueSelectedForFilterRule(FilterKey.AREA),
+        new OnlyFiltersSelectedRule([FilterKey.CITY, FilterKey.COUNTRY, FilterKey.AREA])
+    ];
+    async generateUrls() {
+        const cityFragments = await CityPresenter
+            .getInstance(this.dependencies.searchApiClient)
+            .getFragments();
+        const paths = [];
+        for (const city of cityFragments) {
+            const filterKeyValues = new Map([
+                [FilterKey.CITY, [city.id]],
+                [FilterKey.AREA, [city.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.CITY;
+    }
+}

package/dist/src/organisations/policies/our-picks/CountryCity.d.ts

@@ -0,0 +1,13 @@
+import { FilterCombinations } from '../../../enums/FilterCombinations';
+import { SortingOptions } from '../../../enums/SortingOptions';
+import { OrganisationsSeoIndexabilityPolicy } from '../../../organisations/policies/OrganisationsSeoIndexabilityPolicy';
+import { SingleValueSelectedForFilterRule } from '../../../common/rules/SingleValueSelectedForFilterRule';
+import { OnlyFiltersSelectedRule } from '../../../common/rules/OnlyFiltersSelectedRule';
+export declare class CountryCity extends OrganisationsSeoIndexabilityPolicy {
+    readonly name: string;
+    readonly description: string;
+    protected readonly sortingOption = SortingOptions.OUR_PICKS;
+    protected readonly baseRules: (SingleValueSelectedForFilterRule | OnlyFiltersSelectedRule)[];
+    protected generateUrls(): Promise<string[]>;
+    get filterCombination(): FilterCombinations;
+}

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

@@ -0,0 +1,37 @@
+import { FilterCombinations } from '../../../enums/FilterCombinations';
+import { FilterKey } from '@studyportals/search-filters/server-side';
+import { SortingOptions } from '../../../enums/SortingOptions';
+import { OrganisationsSeoIndexabilityPolicy } from '../../../organisations/policies/OrganisationsSeoIndexabilityPolicy';
+import { CityPresenter } from '../../../presenters/CityPresenter';
+import { SingleValueSelectedForFilterRule } from '../../../common/rules/SingleValueSelectedForFilterRule';
+import { OnlyFiltersSelectedRule } from '../../../common/rules/OnlyFiltersSelectedRule';
+export class CountryCity extends OrganisationsSeoIndexabilityPolicy {
+    name = 'Country City Policy';
+    description = 'Controls indexing of pages filtered by geographic cities, ensuring only SEO-valuable regional content with sufficient search volume is indexed.';
+    sortingOption = SortingOptions.OUR_PICKS;
+    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)
+            .getFragments();
+        const paths = [];
+        for (const city of cityFragments) {
+            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.CITY;
+    }
+}

package/dist/src/organisations/rules/OnlyFullLocationFiltersSelectedRule.js

@@ -8,8 +8,7 @@ export class OnlyFullLocationFiltersSelectedRule {
         return await this.isEligible(dependencies);
     }
     forSitemapGenerator() {
-        //TODO
-        return Promise.resolve(false);
+        return Promise.resolve(true);
     }
     getDescription() {
         return `Only city, country and area (if US, UK or AU) filters are selected`;

package/dist/src/presenters/CityPresenter.d.ts

@@ -1,11 +1,10 @@
 import { FilterKey } from '@studyportals/search-filters/server-side';
 import { ICityFragment } from './fragments/ICityFragment';
-import { IPresenter, ISearchApiClient } from '../../sitemap-generator-seo';
-export declare class CityPresenter implements IPresenter {
+import { ISearchApiClient } from '../../sitemap-generator-seo';
+export declare class CityPresenter {
     readonly filterKey: FilterKey;
     private searchApiClient;
     private static instance;
-    private resultSize;
     private constructor();
     private fragmentsPromise;
     static getInstance(searchApiClient: ISearchApiClient): CityPresenter;

package/dist/src/presenters/CityPresenter.js

@@ -6,7 +6,6 @@ export class CityPresenter {
     filterKey = FilterKey.CITY;
     searchApiClient;
     static instance;
-    resultSize = 600;
     constructor(searchApiClient) {
         this.searchApiClient = searchApiClient;
     }
@@ -25,24 +24,28 @@ export class CityPresenter {
     }
     async fetchCities() {
         try {
+            if (!this.searchApiClient.getCities) {
+                console.error('searchApiClient.getCities is not found');
+                throw new Error('searchApiClient.getCities is not found');
+            }
             const data = await this.searchApiClient.getCities();
             const cityFragments = data.map(city => {
                 const country = countriesExtendedAll.find(item => item.iso?.toLowerCase() === city.countryIsoCode?.toLowerCase());
                 let cityPath = ``;
                 const countryPath = countryGetIsoCodePath(country?.iso || '');
                 if (city.areaId === null || city.areaId === undefined) {
-                    cityPath += countryPath;
+                    cityPath += `${countryPath}/`;
                 }
-                if (!city.areaId || city.areaId !== null) {
+                else {
                     const area = areaGetPath(city.areaId?.toString() || '');
                     if (area && area !== '') {
-                        cityPath += `/${area}`;
+                        cityPath += `${area}/`;
                     }
                     else {
-                        cityPath += countryPath;
+                        cityPath += `${countryPath}/`;
                     }
                 }
-                cityPath += `/${city.virtualPath}`;
+                cityPath += `${city.virtualPath}`;
                 return {
                     id: city.id.toString(),
                     path: cityPath,

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

@@ -2,13 +2,13 @@ import { FilterKeyValuesMap } from '../common/FilterKeyValuesMap';
 export interface ISearchApiClient {
     getOrganisationIds(): Promise<number[]>;
     getCityIds?(): Promise<number[]>;
-    getCities(): Promise<{
+    getCities?(): Promise<{
         id: number;
         name: string;
         virtualPath: string;
         areaId: number | null;
         countryIsoCode: string;
     }[]>;
-    getProgrammeCount(filterKeyValues: FilterKeyValuesMap): Promise<number>;
+    getProgrammeCount?(filterKeyValues: FilterKeyValuesMap): Promise<number>;
     getCount(filterKeyValues: FilterKeyValuesMap): Promise<number>;
 }

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

@@ -1,12 +1,13 @@
 import { DependencyTypes } from '../enums/DependencyTypes';
 import { BaseSitemapUrlGeneratorManager } from './BaseSitemapUrlGeneratorManager';
-import { City, Area, AreaAttendance, Attendance, Continent, Country, 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 } from '../organisations/policies';
 import { AreaPresenter } from '../presenters/AreaPresenter';
 import { AttendancePresenter } from '../presenters/AttendancePresenter';
 import { ContinentPresenter } from '../presenters/ContinentPresenter';
 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';
 export class OrganisationsSitemapUrlGeneratorManager extends BaseSitemapUrlGeneratorManager {
     portalType;
     policies;
@@ -22,7 +23,8 @@ export class OrganisationsSitemapUrlGeneratorManager extends BaseSitemapUrlGener
             rankingApiClient
         };
         this.policies = [
-            new City(dependencies),
+            new CountryCity(dependencies),
+            new CountryAreaCity(dependencies),
             new Area(dependencies),
             new AreaAttendance(dependencies),
             new Attendance(dependencies),

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@studyportals/fawkes",
-	"version": "8.2.4-0",
+	"version": "8.2.4-10",
 	"description": "A package to centralize SEO related logic for SBLP and Sitemap Generator.",
 	"files": [
 		"./dist"
@@ -99,7 +99,7 @@
 		"@rollup/rollup-linux-x64-gnu": "4.24.0"
 	},
 	"engines": {
-		"node": ">=18 <=22",
-		"npm": ">=8 <=10"
+		"node": ">=18 <=24",
+		"npm": ">=8 <=11"
 	}
 }