@studyportals/fawkes 8.5.3-1 → 8.5.3-3

package/README.md

@@ -1,176 +1,176 @@
-# fawkes
-
-This project is used to centralize indexability logic for our Search
-microservices and Sitemap Generator. The main purpose is to completely remove
-discrepancies between pages indexed by Search and page URLs stored in Sitemap.
-
-Link to documentation: https://studyportals.atlassian.net/wiki/x/BwAdvw
-
-## Base structure
-
-- organisations-seo (used by Organisation Search)
-- scholarships-seo (used by Scholarship Search)
-- sitemap-generator-seo (used by Sitemap Generator)
-- src
-  - common
-  - organisations
-  - scholarships
-  - sitemap-generator
-
-# Automatic Documentation System
-
-## Overview
-
-This system automatically generates and maintains documentation for Fawkes
-indexing rules across multiple projects. It creates a hierarchical structure of
-Confluence pages that document all indexing policies and rules, ensuring that
-the documentation is always up-to-date with the actual codebase.
-
-Link to documentation:
-[Fawkes Indexing Rules Documentation](https://studyportals.atlassian.net/wiki/spaces/T/pages/3494969354/Fawkes+Indexing+Rules+Documentation)
-
-## Features
-
-- **Dynamic Documentation**: Automatically extracts indexing rules and policies
-  directly from the codebase
-- **Multi-Page Structure**: Creates a main index page with separate pages for
-  each project
-- **Hierarchical Organization**: Structures content as Projects → Policies →
-  Rules
-- **Automatic Page Creation**: Intelligently creates or updates pages as needed
-- **Cross-Page Navigation**: Provides intuitive navigation between all pages
-
-## Architecture
-
-The system follows SOLID design principles to ensure maintainability and
-extensibility:
-
-- **Single Responsibility**: Each class has one specific responsibility
-- **Open/Closed**: Easily extendable without modifying existing code
-- **Liskov Substitution**: Interchangeable components through well-defined
-  interfaces
-- **Interface Segregation**: Clean, focused interfaces
-- **Dependency Inversion**: High-level modules depend on abstractions
-
-### Key Components
-
-1. **Content Builder**: Extracts project, policy, and rule data from the Fawkes
-   system
-2. **Policy Fetchers**: Project-specific components that fetch and format policy
-   data
-3. **Document Builder**: Generates structured HTML content for Confluence pages
-4. **Confluence Updater**: Handles creation and updating of Confluence pages
-5. **Token Retriever**: Securely retrieves API token for Confluence access
-
-## How It Works
-
-1. The system starts by collecting all project data using the `ContentBuilder`
-2. For each project, it extracts policies and rules using project-specific
-   fetchers
-3. The `DocumentBuilder` generates the content for the main index page and each
-   project page
-4. The `ConfluenceUpdater` creates or updates pages in Confluence as needed
-5. Each project page links back to the main index, and the main index links to
-   all project pages
-
-## Setup and Configuration
-
-### Environment Variables
-
-The system requires the following environment variables:
-
-```
-CONFLUENCE_EMAIL=your-email@example.com
-CONFLUENCE_API_TOKEN=your-api-token
-CONFLUENCE_BASE_URL=https://your-instance.atlassian.net
-CONFLUENCE_SPACE_KEY=YOUR_SPACE_KEY
-CONFLUENCE_MAIN_PAGE_TITLE=Fawkes Indexing Rules Documentation
-```
-
-> **Important Note on Credentials**: Currently, the system uses personal
-> credentials (email and API token) for Confluence access. This is a temporary
-> solution and should be replaced with a team or service account in the future
-> to avoid dependency on a specific individual's account.
-
-### Deployment and Triggering
-
-The system runs as an AWS Lambda function and is automatically triggered as part
-of the CI/CD pipeline. This ensures documentation is always updated whenever new
-code is deployed:
-
-```yaml
-# buildspec.yml (excerpt)
-post_build:
-  commands:
-    - |
-      if [ -z "$PR_ID" ]; then
-        LAMBDA_NAME="FawkesConfluenceUpdater-$STAGE"
-        echo "Invoking Lambda function $LAMBDA_NAME"
-        echo '{"source":"cicd-pipeline","timestamp":"'$(date -u +"%Y-%m-%dT%H:%M:%SZ")'"}' > payload.json
-        aws lambda invoke --function-name $LAMBDA_NAME --invocation-type Event --payload fileb://payload.json response.json || echo "Lambda invocation failed, but continuing"
-      fi
-```
-
-**Trigger Flow:**
-
-1. When code is pushed to the `main` branch, the CI/CD pipeline is triggered
-2. After successful deployment of a new Fawkes version, the post-build phase
-   executes
-3. The Lambda function is invoked with a simple payload containing the source
-   and timestamp
-4. The Lambda function authenticates with Confluence and executes the
-   documentation generation process
-5. This only happens for production deployments (not PR builds)
-
-This automated approach ensures documentation stays in sync with the actual
-codebase without manual intervention.
-
-## Scalability and Extension
-
-### Adding New Projects
-
-To add documentation for a new project:
-
-1. Create a new class that implements the `IPolicyFetcher` interface
-2. Implement the `getProjectName()` and `fetchPolicies()` methods
-3. Register the new fetcher in the `ContentBuilder` constructor
-
-Example:
-
-```typescript
-export class NewProjectPolicyFetcher implements IPolicyFetcher {
-  getProjectName(): string {
-    return 'New Project Name';
-  }
-
-  fetchPolicies(): IPolicy[] {
-    // Implement policy fetching logic
-    return [...policies];
-  }
-}
-
-// Then update ContentBuilder:
-constructor(fetchers?: IPolicyFetcher[]) {
-  this.policyFetchers = fetchers || [
-    // Existing fetchers
-    new NewProjectPolicyFetcher()
-  ];
-}
-```
-
-### Customizing Page Content
-
-The `DocumentBuilder` class contains methods for generating page content. To
-customize the format:
-
-1. Modify the `buildMainDocument()` method for changes to the main index page
-2. Modify the `buildProjectDocument()` method for changes to project pages
-3. Modify the `buildPolicySection()` and `buildRulesTable()` methods for changes
-   to policy and rule sections
-
-## Conclusion
-
-This documentation system ensures that Fawkes indexing rules are always
-well-documented and accessible to the team. By automatically generating
-documentation directly from the codebase, it eliminates the risk of
-documentation becoming outdated or inconsistent with the actual implementation.
+# fawkes
+
+This project is used to centralize indexability logic for our Search
+microservices and Sitemap Generator. The main purpose is to completely remove
+discrepancies between pages indexed by Search and page URLs stored in Sitemap.
+
+Link to documentation: https://studyportals.atlassian.net/wiki/x/BwAdvw
+
+## Base structure
+
+- organisations-seo (used by Organisation Search)
+- scholarships-seo (used by Scholarship Search)
+- sitemap-generator-seo (used by Sitemap Generator)
+- src
+  - common
+  - organisations
+  - scholarships
+  - sitemap-generator
+
+# Automatic Documentation System
+
+## Overview
+
+This system automatically generates and maintains documentation for Fawkes
+indexing rules across multiple projects. It creates a hierarchical structure of
+Confluence pages that document all indexing policies and rules, ensuring that
+the documentation is always up-to-date with the actual codebase.
+
+Link to documentation:
+[Fawkes Indexing Rules Documentation](https://studyportals.atlassian.net/wiki/spaces/T/pages/3494969354/Fawkes+Indexing+Rules+Documentation)
+
+## Features
+
+- **Dynamic Documentation**: Automatically extracts indexing rules and policies
+  directly from the codebase
+- **Multi-Page Structure**: Creates a main index page with separate pages for
+  each project
+- **Hierarchical Organization**: Structures content as Projects → Policies →
+  Rules
+- **Automatic Page Creation**: Intelligently creates or updates pages as needed
+- **Cross-Page Navigation**: Provides intuitive navigation between all pages
+
+## Architecture
+
+The system follows SOLID design principles to ensure maintainability and
+extensibility:
+
+- **Single Responsibility**: Each class has one specific responsibility
+- **Open/Closed**: Easily extendable without modifying existing code
+- **Liskov Substitution**: Interchangeable components through well-defined
+  interfaces
+- **Interface Segregation**: Clean, focused interfaces
+- **Dependency Inversion**: High-level modules depend on abstractions
+
+### Key Components
+
+1. **Content Builder**: Extracts project, policy, and rule data from the Fawkes
+   system
+2. **Policy Fetchers**: Project-specific components that fetch and format policy
+   data
+3. **Document Builder**: Generates structured HTML content for Confluence pages
+4. **Confluence Updater**: Handles creation and updating of Confluence pages
+5. **Token Retriever**: Securely retrieves API token for Confluence access
+
+## How It Works
+
+1. The system starts by collecting all project data using the `ContentBuilder`
+2. For each project, it extracts policies and rules using project-specific
+   fetchers
+3. The `DocumentBuilder` generates the content for the main index page and each
+   project page
+4. The `ConfluenceUpdater` creates or updates pages in Confluence as needed
+5. Each project page links back to the main index, and the main index links to
+   all project pages
+
+## Setup and Configuration
+
+### Environment Variables
+
+The system requires the following environment variables:
+
+```
+CONFLUENCE_EMAIL=your-email@example.com
+CONFLUENCE_API_TOKEN=your-api-token
+CONFLUENCE_BASE_URL=https://your-instance.atlassian.net
+CONFLUENCE_SPACE_KEY=YOUR_SPACE_KEY
+CONFLUENCE_MAIN_PAGE_TITLE=Fawkes Indexing Rules Documentation
+```
+
+> **Important Note on Credentials**: Currently, the system uses personal
+> credentials (email and API token) for Confluence access. This is a temporary
+> solution and should be replaced with a team or service account in the future
+> to avoid dependency on a specific individual's account.
+
+### Deployment and Triggering
+
+The system runs as an AWS Lambda function and is automatically triggered as part
+of the CI/CD pipeline. This ensures documentation is always updated whenever new
+code is deployed:
+
+```yaml
+# buildspec.yml (excerpt)
+post_build:
+  commands:
+    - |
+      if [ -z "$PR_ID" ]; then
+        LAMBDA_NAME="FawkesConfluenceUpdater-$STAGE"
+        echo "Invoking Lambda function $LAMBDA_NAME"
+        echo '{"source":"cicd-pipeline","timestamp":"'$(date -u +"%Y-%m-%dT%H:%M:%SZ")'"}' > payload.json
+        aws lambda invoke --function-name $LAMBDA_NAME --invocation-type Event --payload fileb://payload.json response.json || echo "Lambda invocation failed, but continuing"
+      fi
+```
+
+**Trigger Flow:**
+
+1. When code is pushed to the `main` branch, the CI/CD pipeline is triggered
+2. After successful deployment of a new Fawkes version, the post-build phase
+   executes
+3. The Lambda function is invoked with a simple payload containing the source
+   and timestamp
+4. The Lambda function authenticates with Confluence and executes the
+   documentation generation process
+5. This only happens for production deployments (not PR builds)
+
+This automated approach ensures documentation stays in sync with the actual
+codebase without manual intervention.
+
+## Scalability and Extension
+
+### Adding New Projects
+
+To add documentation for a new project:
+
+1. Create a new class that implements the `IPolicyFetcher` interface
+2. Implement the `getProjectName()` and `fetchPolicies()` methods
+3. Register the new fetcher in the `ContentBuilder` constructor
+
+Example:
+
+```typescript
+export class NewProjectPolicyFetcher implements IPolicyFetcher {
+  getProjectName(): string {
+    return 'New Project Name';
+  }
+
+  fetchPolicies(): IPolicy[] {
+    // Implement policy fetching logic
+    return [...policies];
+  }
+}
+
+// Then update ContentBuilder:
+constructor(fetchers?: IPolicyFetcher[]) {
+  this.policyFetchers = fetchers || [
+    // Existing fetchers
+    new NewProjectPolicyFetcher()
+  ];
+}
+```
+
+### Customizing Page Content
+
+The `DocumentBuilder` class contains methods for generating page content. To
+customize the format:
+
+1. Modify the `buildMainDocument()` method for changes to the main index page
+2. Modify the `buildProjectDocument()` method for changes to project pages
+3. Modify the `buildPolicySection()` and `buildRulesTable()` methods for changes
+   to policy and rule sections
+
+## Conclusion
+
+This documentation system ensures that Fawkes indexing rules are always
+well-documented and accessible to the team. By automatically generating
+documentation directly from the codebase, it eliminates the risk of
+documentation becoming outdated or inconsistent with the actual implementation.

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

@@ -73,8 +73,6 @@ 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,8 +74,6 @@ 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, RankedCountryCity, RankedCountryAreaCity } 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) {
@@ -31,8 +31,6 @@ 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,5 +18,3 @@ 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,5 +18,3 @@ 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/programmes/ProgrammesBaseIndexabilityPolicy.js

@@ -2,6 +2,7 @@ import { MinimumAmountOfResultsRule } from './rules/MinimumAmountOfResultsRule';
 import { IndexablePageNumberRule } from './rules/IndexablePageNumberRule';
 import { NotDistanceLearningPortalRule } from './rules/NotDistanceLearningPortalRule';
 import { BaseSeoIndexabilityPolicy } from '../common/policies/BaseSeoIndexabilityPolicy';
+import { FilterKey } from '@studyportals/search-filters/server-side';
 export class ProgrammesBaseIndexabilityPolicy extends BaseSeoIndexabilityPolicy {
     indexablePageNumbers = [1];
     initateBaseRules() {
@@ -20,6 +21,10 @@ export class ProgrammesBaseIndexabilityPolicy extends BaseSeoIndexabilityPolicy
         this.rules.push(atLeastSevenResultsRule, notDistanceLearningPortalRule, indexablePageNumberRule);
     }
     async checkRulesForSitemapWithPageNumber(filterKeyValues, pageNumber) {
+        const dependencies = this.dependencies;
+        if (!Object.keys(filterKeyValues).some(key => key === FilterKey.EDUCATION_LEVEL)) {
+            filterKeyValues[FilterKey.EDUCATION_LEVEL] = [dependencies.portalType];
+        }
         for (const rule of this.rules) {
             let result;
             if ('forSitemapGeneratorWithPageNumber' in rule) {

package/dist/src/programmes/policies/AttendanceDegree.d.ts

@@ -1,16 +1,13 @@
 import { FilterKey } from '@studyportals/search-filters/server-side';
-import { OnlyFiltersSelectedRule } from '../../common/rules/OnlyFiltersSelectedRule';
-import { SingleValueSelectedForFilterRule } from '../../common/rules/SingleValueSelectedForFilterRule';
 import { FilterCombinations } from '../../enums/FilterCombinations';
 import { ProgrammesBaseIndexabilityPolicy } from '../ProgrammesBaseIndexabilityPolicy';
 import { IProgrammeSeoDependencies } from '../types/IProgrammeSeoDependencies';
-import { IndexableDegreeRule } from '../rules/IndexableDegreeRule';
-import { BlendedOrOnlineAttendanceRule } from '../rules/BlendedOrOnlineAttendanceRule';
+import { IRule } from '../../common/IRule';
 export declare class AttendanceDegree extends ProgrammesBaseIndexabilityPolicy {
     readonly name: string;
     readonly description: string;
     readonly filterKeys: FilterKey[];
-    protected readonly rules: (SingleValueSelectedForFilterRule | OnlyFiltersSelectedRule | IndexableDegreeRule | BlendedOrOnlineAttendanceRule)[];
+    protected readonly rules: IRule[];
     constructor(dependencies: IProgrammeSeoDependencies);
     protected generateUrls(): Promise<string[]>;
     get filterCombination(): FilterCombinations;

package/dist/src/programmes/policies/AttendanceDegree.js

@@ -11,15 +11,19 @@ export class AttendanceDegree extends ProgrammesBaseIndexabilityPolicy {
     name = 'Attendance Degree Type Policy';
     description = 'Determines indexing rules for pages filtered by both study format (online, blended, on-campus, etc.), and degree type prioritizing degrees and formats with demonstrated search demand.';
     filterKeys = [FilterKey.DELIVERY_METHOD, FilterKey.DEGREE_TYPE];
-    rules = [
-        new SingleValueSelectedForFilterRule(FilterKey.DELIVERY_METHOD),
-        new SingleValueSelectedForFilterRule(FilterKey.DEGREE_TYPE),
-        new OnlyFiltersSelectedRule([FilterKey.DELIVERY_METHOD, FilterKey.DEGREE_TYPE]),
-        new IndexableDegreeRule(),
-        new BlendedOrOnlineAttendanceRule()
-    ];
+    rules;
     constructor(dependencies) {
         super(dependencies);
+        const portalType = this.isSitemapUrlGeneratorDependencies()
+            ? dependencies.portalType
+            : undefined;
+        this.rules = [
+            new SingleValueSelectedForFilterRule(FilterKey.DELIVERY_METHOD),
+            new SingleValueSelectedForFilterRule(FilterKey.DEGREE_TYPE),
+            new OnlyFiltersSelectedRule([FilterKey.DELIVERY_METHOD, FilterKey.DEGREE_TYPE]),
+            new IndexableDegreeRule(portalType),
+            new BlendedOrOnlineAttendanceRule()
+        ];
         this.initateBaseRules();
     }
     async generateUrls() {

package/dist/src/programmes/policies/CountryAttendanceDegree.js

@@ -10,7 +10,7 @@ import { AttendancePresenter } from '../../presenters/AttendancePresenter';
 import { DegreePresenter } from '../../presenters/DegreePresenter';
 export class CountryAttendanceDegree extends ProgrammesBaseIndexabilityPolicy {
     name = 'Country Attendance Degree Policy';
-    description = `Determines indexing rules for pages filtered by country,
+    description = `Determines indexing rules for pages filtered by country,
 		study format (online, on-campus, etc.), and degree type.`;
     filterKeys = [FilterKey.COUNTRY, FilterKey.DELIVERY_METHOD, FilterKey.DEGREE_TYPE];
     rules = [

package/dist/src/programmes/policies/CountryDegree.d.ts

@@ -1,15 +1,13 @@
 import { FilterKey } from '@studyportals/search-filters/server-side';
-import { OnlyFiltersSelectedRule } from '../../common/rules/OnlyFiltersSelectedRule';
-import { SingleValueSelectedForFilterRule } from '../../common/rules/SingleValueSelectedForFilterRule';
 import { FilterCombinations } from '../../enums/FilterCombinations';
-import { IndexableDegreeRule } from '../rules/IndexableDegreeRule';
 import { ProgrammesBaseIndexabilityPolicy } from '../ProgrammesBaseIndexabilityPolicy';
 import { IProgrammeSeoDependencies } from '../types/IProgrammeSeoDependencies';
+import { IRule } from '../../common/IRule';
 export declare class CountryDegree extends ProgrammesBaseIndexabilityPolicy {
     readonly name: string;
     readonly description: string;
     readonly filterKeys: FilterKey[];
-    protected readonly rules: (SingleValueSelectedForFilterRule | OnlyFiltersSelectedRule | IndexableDegreeRule)[];
+    protected readonly rules: IRule[];
     constructor(dependencies: IProgrammeSeoDependencies);
     protected generateUrls(): Promise<string[]>;
     get filterCombination(): FilterCombinations;

package/dist/src/programmes/policies/CountryDegree.js

@@ -10,14 +10,18 @@ export class CountryDegree extends ProgrammesBaseIndexabilityPolicy {
     name = 'Country Degree Policy';
     description = 'Determines indexing rules for pages filtered by both country, and degree type.';
     filterKeys = [FilterKey.COUNTRY, FilterKey.DEGREE_TYPE];
-    rules = [
-        new SingleValueSelectedForFilterRule(FilterKey.COUNTRY),
-        new SingleValueSelectedForFilterRule(FilterKey.DEGREE_TYPE),
-        new OnlyFiltersSelectedRule([FilterKey.COUNTRY, FilterKey.DEGREE_TYPE]),
-        new IndexableDegreeRule()
-    ];
+    rules;
     constructor(dependencies) {
         super(dependencies);
+        const portalType = this.isSitemapUrlGeneratorDependencies()
+            ? dependencies.portalType
+            : undefined;
+        this.rules = [
+            new SingleValueSelectedForFilterRule(FilterKey.COUNTRY),
+            new SingleValueSelectedForFilterRule(FilterKey.DEGREE_TYPE),
+            new OnlyFiltersSelectedRule([FilterKey.COUNTRY, FilterKey.DEGREE_TYPE]),
+            new IndexableDegreeRule(portalType)
+        ];
         this.initateBaseRules();
     }
     async generateUrls() {

package/dist/src/programmes/policies/CountryDurationDegree.js

@@ -10,7 +10,7 @@ import { DegreePresenter } from '../../presenters/DegreePresenter';
 import { DurationPresenter } from '../../presenters/DurationPresenter';
 export class CountryDurationDegree extends ProgrammesBaseIndexabilityPolicy {
     name = 'Country Duration Degree Policy';
-    description = `Determines indexing rules for pages filtered by country,
+    description = `Determines indexing rules for pages filtered by country,
 		duration (1 year, 2 years, etc.), and degree type.`;
     filterKeys = [FilterKey.COUNTRY, FilterKey.DURATION, FilterKey.DEGREE_TYPE];
     rules = [

package/dist/src/programmes/policies/CountryEducationalForm.d.ts

@@ -1,15 +1,13 @@
 import { FilterKey } from '@studyportals/search-filters/server-side';
-import { OnlyFiltersSelectedRule } from '../../common/rules/OnlyFiltersSelectedRule';
-import { SingleValueSelectedForFilterRule } from '../../common/rules/SingleValueSelectedForFilterRule';
 import { FilterCombinations } from '../../enums/FilterCombinations';
-import { IndexableEducationalFormRule } from '../rules/IndexableEducationalFormRule';
 import { ProgrammesBaseIndexabilityPolicy } from '../ProgrammesBaseIndexabilityPolicy';
 import { IProgrammeSeoDependencies } from '../types/IProgrammeSeoDependencies';
+import { IRule } from '../../common/IRule';
 export declare class CountryEducationalForm extends ProgrammesBaseIndexabilityPolicy {
     readonly name: string;
     readonly description: string;
     readonly filterKeys: FilterKey[];
-    protected readonly rules: (SingleValueSelectedForFilterRule | OnlyFiltersSelectedRule | IndexableEducationalFormRule)[];
+    protected readonly rules: IRule[];
     constructor(dependencies: IProgrammeSeoDependencies);
     protected generateUrls(): Promise<string[]>;
     get filterCombination(): FilterCombinations;

package/dist/src/programmes/policies/CountryEducationalForm.js

@@ -8,17 +8,21 @@ import { CountryPresenter } from '../../presenters/CountryPresenter';
 import { EducationalFormPresenter } from '../../presenters/EducationalFormPresenter';
 export class CountryEducationalForm extends ProgrammesBaseIndexabilityPolicy {
     name = 'Country Educational Form Policy';
-    description = `Determines indexing rules for pages filtered by both country,
+    description = `Determines indexing rules for pages filtered by both country,
 		and educational form (academic, semester, summer school, etc.).`;
     filterKeys = [FilterKey.COUNTRY, FilterKey.EDUCATIONAL_FORM];
-    rules = [
-        new SingleValueSelectedForFilterRule(FilterKey.COUNTRY),
-        new SingleValueSelectedForFilterRule(FilterKey.EDUCATIONAL_FORM),
-        new OnlyFiltersSelectedRule([FilterKey.COUNTRY, FilterKey.EDUCATIONAL_FORM]),
-        new IndexableEducationalFormRule()
-    ];
+    rules;
     constructor(dependencies) {
         super(dependencies);
+        const portalType = this.isSitemapUrlGeneratorDependencies()
+            ? dependencies.portalType
+            : undefined;
+        this.rules = [
+            new SingleValueSelectedForFilterRule(FilterKey.COUNTRY),
+            new SingleValueSelectedForFilterRule(FilterKey.EDUCATIONAL_FORM),
+            new OnlyFiltersSelectedRule([FilterKey.COUNTRY, FilterKey.EDUCATIONAL_FORM]),
+            new IndexableEducationalFormRule(portalType)
+        ];
         this.initateBaseRules();
     }
     async generateUrls() {

package/dist/src/programmes/policies/DegreeAttendanceTuitionFee.d.ts

@@ -1,17 +1,13 @@
 import { FilterKey } from '@studyportals/search-filters/server-side';
-import { OnlyFiltersSelectedRule } from '../../common/rules/OnlyFiltersSelectedRule';
-import { SingleValueSelectedForFilterRule } from '../../common/rules/SingleValueSelectedForFilterRule';
 import { FilterCombinations } from '../../enums/FilterCombinations';
 import { ProgrammesBaseIndexabilityPolicy } from '../ProgrammesBaseIndexabilityPolicy';
 import { IProgrammeSeoDependencies } from '../types/IProgrammeSeoDependencies';
-import { OnlineAttendanceRule } from '../../common/rules/OnlineAttendanceRule';
-import { IndexableDegreeRule } from '../rules/IndexableDegreeRule';
-import { AffordableTuitionFeeRule } from '../rules/AffordableTuitionFeeRule';
+import { IRule } from '../../common/IRule';
 export declare class DegreeAttendanceTuitionFee extends ProgrammesBaseIndexabilityPolicy {
     readonly name: string;
     readonly description: string;
     readonly filterKeys: FilterKey[];
-    protected readonly rules: (SingleValueSelectedForFilterRule | OnlyFiltersSelectedRule | OnlineAttendanceRule | IndexableDegreeRule | AffordableTuitionFeeRule)[];
+    protected readonly rules: IRule[];
     constructor(dependencies: IProgrammeSeoDependencies);
     protected generateUrls(): Promise<string[]>;
     get filterCombination(): FilterCombinations;

package/dist/src/programmes/policies/DegreeAttendanceTuitionFee.js

@@ -14,17 +14,21 @@ export class DegreeAttendanceTuitionFee extends ProgrammesBaseIndexabilityPolicy
     name = 'Tuition Fee Attendance Degree Policy';
     description = 'Determines indexing rules for pages filtered by tuition fee, attendance, and degree type.';
     filterKeys = [FilterKey.TUITION_FEE, FilterKey.DELIVERY_METHOD, FilterKey.DEGREE_TYPE];
-    rules = [
-        new SingleValueSelectedForFilterRule(FilterKey.DEGREE_TYPE),
-        new SingleValueSelectedForFilterRule(FilterKey.DELIVERY_METHOD),
-        new SingleValueSelectedForFilterRule(FilterKey.TUITION_FEE),
-        new OnlyFiltersSelectedRule([FilterKey.DEGREE_TYPE, FilterKey.DELIVERY_METHOD, FilterKey.TUITION_FEE]),
-        new IndexableDegreeRule(),
-        new OnlineAttendanceRule(),
-        new AffordableTuitionFeeRule()
-    ];
+    rules;
     constructor(dependencies) {
         super(dependencies);
+        const portalType = this.isSitemapUrlGeneratorDependencies()
+            ? dependencies.portalType
+            : undefined;
+        this.rules = [
+            new SingleValueSelectedForFilterRule(FilterKey.DEGREE_TYPE),
+            new SingleValueSelectedForFilterRule(FilterKey.DELIVERY_METHOD),
+            new SingleValueSelectedForFilterRule(FilterKey.TUITION_FEE),
+            new OnlyFiltersSelectedRule([FilterKey.DEGREE_TYPE, FilterKey.DELIVERY_METHOD, FilterKey.TUITION_FEE]),
+            new IndexableDegreeRule(portalType),
+            new OnlineAttendanceRule(),
+            new AffordableTuitionFeeRule()
+        ];
         this.initateBaseRules();
     }
     async generateUrls() {