@studyportals/fawkes 8.3.0 → 8.4.0

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

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

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

@@ -5,6 +5,7 @@ import { OrganisationsSeoIndexabilityPolicy } from '../../../organisations/polic
 import { SingleValueSelectedForFilterRule } from '../../../common/rules/SingleValueSelectedForFilterRule';
 import { OnlyFiltersSelectedRule } from '../../../common/rules/OnlyFiltersSelectedRule';
 import { CityPresenter } from '../../../presenters/CityPresenter';
+import { ExcludeByIdForCitiesRule } from '../../../organisations/rules/ExcludeByIdForCitiesRule';
 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.';
@@ -13,7 +14,8 @@ export class CountryAreaCity extends OrganisationsSeoIndexabilityPolicy {
         new SingleValueSelectedForFilterRule(FilterKey.CITY),
         new SingleValueSelectedForFilterRule(FilterKey.COUNTRY),
         new SingleValueSelectedForFilterRule(FilterKey.AREA),
-        new OnlyFiltersSelectedRule([FilterKey.CITY, FilterKey.COUNTRY, FilterKey.AREA])
+        new OnlyFiltersSelectedRule([FilterKey.CITY, FilterKey.COUNTRY, FilterKey.AREA]),
+        new ExcludeByIdForCitiesRule(FilterKey.CITY)
     ];
     async generateUrls() {
         const cityFragments = await CityPresenter

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

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

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

@@ -5,6 +5,7 @@ import { OrganisationsSeoIndexabilityPolicy } from '../../../organisations/polic
 import { CityPresenter } from '../../../presenters/CityPresenter';
 import { SingleValueSelectedForFilterRule } from '../../../common/rules/SingleValueSelectedForFilterRule';
 import { OnlyFiltersSelectedRule } from '../../../common/rules/OnlyFiltersSelectedRule';
+import { ExcludeByIdForCitiesRule } from '../../../organisations/rules/ExcludeByIdForCitiesRule';
 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.';
@@ -12,7 +13,8 @@ export class CountryCity extends OrganisationsSeoIndexabilityPolicy {
     baseRules = [
         new SingleValueSelectedForFilterRule(FilterKey.CITY),
         new SingleValueSelectedForFilterRule(FilterKey.COUNTRY),
-        new OnlyFiltersSelectedRule([FilterKey.CITY, FilterKey.COUNTRY])
+        new OnlyFiltersSelectedRule([FilterKey.CITY, FilterKey.COUNTRY]),
+        new ExcludeByIdForCitiesRule(FilterKey.CITY)
     ];
     async generateUrls() {
         const cityFragments = await CityPresenter

package/dist/src/organisations/rules/ExcludeByIdForCitiesRule.d.ts

@@ -0,0 +1,13 @@
+import { IRule } from "../../common/IRule";
+import { ISearchDependencies } from "../../common/ISearchDependencies";
+import { FilterKey } from "@studyportals/search-filters/server-side";
+import { FilterKeyValuesMap } from "../../../sitemap-generator-seo";
+export declare class ExcludeByIdForCitiesRule implements IRule {
+    private readonly filterKey;
+    private excludedIds;
+    constructor(filterKey: FilterKey);
+    forSearch(dependencies: ISearchDependencies): Promise<boolean>;
+    forSitemapGenerator(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
+    getName(): string;
+    getDescription(): string;
+}

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

@@ -0,0 +1,31 @@
+import { FilterKey } from "@studyportals/search-filters/server-side";
+export class ExcludeByIdForCitiesRule {
+    filterKey;
+    excludedIds;
+    constructor(filterKey) {
+        this.filterKey = filterKey;
+        // Exclude city with ID 532 (Washington D.C.)
+        this.excludedIds = ['532'];
+    }
+    async forSearch(dependencies) {
+        const selectedCities = dependencies.seoInfoBase.getFilterOptionValueBy(this.filterKey, dependencies.filterState);
+        if (!selectedCities || selectedCities.trim() === '') {
+            return Promise.resolve(false);
+        }
+        return Promise.resolve(!this.excludedIds.includes(selectedCities));
+    }
+    async forSitemapGenerator(filterKeyValues) {
+        const cities = filterKeyValues.get(FilterKey.CITY);
+        if (cities && cities.length > 0) {
+            const filteredCities = cities.filter(city => !this.excludedIds.includes(city));
+            return Promise.resolve(filteredCities.length > 0);
+        }
+        return Promise.resolve(true);
+    }
+    getName() {
+        return 'ExcludeByIdForCitiesRule';
+    }
+    getDescription() {
+        return `This rule excludes specific city IDs from the search results. (${this.excludedIds.join(", ")})`;
+    }
+}

package/package.json

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