@studyportals/fawkes 8.2.4-8 → 8.2.4-9

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,25 @@
+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';
+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() {
+        // NOTE: Since we have a mechanism for url calculation in CountryCity policy, that covers this scenario. For that reason this method is left unimplemented.
+        // In any case that you delete the CountryCity policy, you should implement this method to avoid losing functionality.
+        return await new Promise((resolve) => resolve([]));
+    }
+    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/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-8",
+	"version": "8.2.4-9",
 	"description": "A package to centralize SEO related logic for SBLP and Sitemap Generator.",
 	"files": [
 		"./dist"