@studyportals/fawkes 5.0.0 → 5.0.1-3

package/README.md

@@ -16,3 +16,161 @@ Link to documentation: https://studyportals.atlassian.net/wiki/x/BwAdvw
   - 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/programmes-seo/index.d.ts

@@ -0,0 +1,6 @@
+import { ISeoFilterState } from '../src/common/ISeoFilterState';
+import { ISeoInfoBase } from '../src/common/ISeoInfoBase';
+import { IProgrammeSearchApplicationState } from '../src/programmes/IProgrammeSearchApplicationState';
+import { ISearchIndexabilityManager } from '../src/common/ISearchIndexabilityManager';
+import { SearchIndexabilityManager } from '../src/programmes/SearchIndexabilityManager';
+export { ISeoFilterState, ISeoInfoBase, ISearchIndexabilityManager, IProgrammeSearchApplicationState, SearchIndexabilityManager };

package/dist/programmes-seo/index.js

@@ -0,0 +1,2 @@
+import { SearchIndexabilityManager } from '../src/programmes/SearchIndexabilityManager';
+export { SearchIndexabilityManager };

package/dist/scholarships-seo/index.d.ts

@@ -1,4 +1,5 @@
+import { ISeoIndexabilityPolicy } from '../src/common/ISeoIndexabilityPolicy';
 import { ISeoFilterState, ISearchApplicationState, ISearchIndexabilityManager, ISeoInfoBase } from '../src/common';
 import { SearchIndexabilityManager } from '../src/scholarships/SearchIndexabilityManager';
 import { types } from '../src/scholarships/types';
-export { ISeoFilterState, ISearchApplicationState, ISearchIndexabilityManager, ISeoInfoBase, SearchIndexabilityManager, types };
+export { ISeoFilterState, ISeoIndexabilityPolicy, ISearchApplicationState, ISearchIndexabilityManager, ISeoInfoBase, SearchIndexabilityManager, types };

package/dist/sitemap-generator-seo/index.d.ts

@@ -6,6 +6,7 @@ import { ISitemapUrlGeneratorManager } from '../src/sitemap-generator/ISitemapUr
 import { OrganisationsSitemapUrlGeneratorManager } from '../src/sitemap-generator/OrganisationsSitemapUrlGeneratorManager';
 import { ScholarshipsSitemapUrlGeneratorManager } from '../src/sitemap-generator/ScholarshipsSitemapUrlGeneratorManager';
 import { FilterCombinations } from '../src/enums/FilterCombinations';
+import { ISitemapUrlGenerator } from '../src/common/ISitemapUrlGenerator';
 import { FilterKeyValuesMap } from '../src/common/FilterKeyValuesMap';
 import { IPresenter } from '../src/common';
-export { IOrganisationsClient, IOrganisation, IRankingApiClient, ISearchApiClient, ISitemapUrlGeneratorManager, OrganisationsSitemapUrlGeneratorManager, ScholarshipsSitemapUrlGeneratorManager, FilterCombinations, FilterKeyValuesMap, IPresenter };
+export { IOrganisationsClient, IOrganisation, IRankingApiClient, ISearchApiClient, ISitemapUrlGeneratorManager, OrganisationsSitemapUrlGeneratorManager, ScholarshipsSitemapUrlGeneratorManager, FilterCombinations, ISitemapUrlGenerator, FilterKeyValuesMap, IPresenter };

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

@@ -0,0 +1,5 @@
+import { ISeoIndexabilityPolicy } from './ISeoIndexabilityPolicy';
+import { ISitemapUrlGenerator } from './ISitemapUrlGenerator';
+export interface IDocumentationManager {
+    getPolicies(): ISitemapUrlGenerator[] | ISeoIndexabilityPolicy[];
+}

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

@@ -1,5 +1,5 @@
-import { IFragment } from "../presenters/fragments/IFragment";
-import { FilterKey } from "@studyportals/search-filters";
+import { IFragment } from '../presenters/fragments/IFragment';
+import { FilterKey } from '@studyportals/search-filters';
 export interface IPresenter {
     readonly filterKey: FilterKey;
     getFragments(): IFragment[];

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

@@ -4,4 +4,5 @@ export interface IRule {
     getName(): string;
     forSearch(dependencies: ISearchDependencies): Promise<boolean>;
     forSitemapGenerator(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
+    getDescription(): string;
 }

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

@@ -1,3 +1,4 @@
-export interface ISearchIndexabilityManager {
+import { IDocumentationManager } from './IDocumentationManager';
+export interface ISearchIndexabilityManager extends IDocumentationManager {
     shouldIndex(): Promise<boolean>;
 }

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

@@ -1,3 +1,7 @@
+import { IRule } from './IRule';
 export interface ISeoIndexabilityPolicy {
     shouldIndex(): Promise<boolean>;
+    getAllRules(): IRule[];
+    getName(): string;
+    getDescription(): string;
 }

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

@@ -1,5 +1,7 @@
 import { FilterCombinations } from '../enums/FilterCombinations';
+import { IRule } from './IRule';
 export interface ISitemapUrlGenerator {
     filterCombination: FilterCombinations;
     generateSitemapUrls(): Promise<string[]>;
+    getAllRules(): IRule[];
 }

package/dist/src/common/policies/BaseSeoIndexabilityPolicy.d.ts

@@ -4,8 +4,10 @@ import { IRule } from '../IRule';
 import { FilterKeyValuesMap } from '../FilterKeyValuesMap';
 import { ISeoIndexabilityPolicy } from '../ISeoIndexabilityPolicy';
 import { ISitemapUrlGenerator } from '../ISitemapUrlGenerator';
-import { FilterCombinations } from '../../../sitemap-generator-seo';
+import { FilterCombinations } from '../../enums/FilterCombinations';
 export declare abstract class BaseSeoIndexabilityPolicy<TDependencies extends IDependencies> implements ISeoIndexabilityPolicy, ISitemapUrlGenerator {
+    abstract readonly name: string;
+    abstract readonly description: string;
     protected readonly dependencies: TDependencies;
     protected abstract readonly rules: IRule[];
     constructor(dependencies: TDependencies);
@@ -18,4 +20,7 @@ export declare abstract class BaseSeoIndexabilityPolicy<TDependencies extends ID
     protected checkRulesForSitemap(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
     protected isIndexabilityPolicyDependencies(): boolean;
     protected isSitemapUrlGeneratorDependencies(): boolean;
+    getAllRules(): IRule[];
+    getName(): string;
+    getDescription(): string;
 }

package/dist/src/common/policies/BaseSeoIndexabilityPolicy.js

@@ -44,4 +44,13 @@ export class BaseSeoIndexabilityPolicy {
     isSitemapUrlGeneratorDependencies() {
         return this.dependencies.dependencyType === DependencyTypes.SITEMAP_GENERATOR;
     }
+    getAllRules() {
+        return this.rules;
+    }
+    getName() {
+        return this.name;
+    }
+    getDescription() {
+        return this.description;
+    }
 }

package/dist/src/common/rules/BaseFilterKeyValueRule.d.ts

@@ -5,6 +5,7 @@ export declare abstract class BaseFilterKeyValueRule implements IRule {
     private readonly expectedFilterKeyValues;
     constructor(expectedFilterKeyValues: FilterKeyValuesMap);
     abstract getName(): string;
+    abstract getDescription(): string;
     forSearch(dependencies: ISearchDependencies): Promise<boolean>;
     forSitemapGenerator(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
 }

package/dist/src/common/rules/NoFiltersSelectedRule.d.ts

@@ -5,4 +5,5 @@ export declare class NoFiltersSelectedRule implements IRule {
     forSearch(dependencies: ISearchDependencies): Promise<boolean>;
     forSitemapGenerator(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
     getName(): string;
+    getDescription(): string;
 }

package/dist/src/common/rules/NoFiltersSelectedRule.js

@@ -11,4 +11,7 @@ export class NoFiltersSelectedRule {
     getName() {
         return 'NoFiltersSelectedRule';
     }
+    getDescription() {
+        return 'No filters are selected';
+    }
 }

package/dist/src/common/rules/OnlineAttendanceRule.d.ts

@@ -0,0 +1,6 @@
+import { BaseFilterKeyValueRule } from '../../common/rules/BaseFilterKeyValueRule';
+export declare class OnlineAttendanceRule extends BaseFilterKeyValueRule {
+    constructor();
+    getName(): string;
+    getDescription(): string;
+}

package/dist/src/common/rules/OnlineAttendanceRule.js

@@ -0,0 +1,14 @@
+import { FilterKey } from '@studyportals/search-filters';
+import { BaseFilterKeyValueRule } from '../../common/rules/BaseFilterKeyValueRule';
+export class OnlineAttendanceRule extends BaseFilterKeyValueRule {
+    constructor() {
+        const filterKeyValues = new Map([[FilterKey.DELIVERY_METHOD, ['online']]]);
+        super(filterKeyValues);
+    }
+    getName() {
+        return 'OnlineAttendanceRule';
+    }
+    getDescription() {
+        return 'Is indexable if the selected delivery method is online.';
+    }
+}

package/dist/src/common/rules/OnlyFiltersSelectedRule.d.ts

@@ -8,4 +8,5 @@ export declare class OnlyFiltersSelectedRule implements IRule {
     getName(): string;
     forSearch(dependencies: ISearchDependencies): Promise<boolean>;
     forSitemapGenerator(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
+    getDescription(): string;
 }

package/dist/src/common/rules/OnlyFiltersSelectedRule.js

@@ -24,4 +24,7 @@ export class OnlyFiltersSelectedRule {
         }
         return Promise.resolve(true);
     }
+    getDescription() {
+        return `Only ${this.filterKeys.join(', ')} filters are selected`;
+    }
 }

package/dist/src/common/rules/SingleValueSelectedForFilterRule.d.ts

@@ -8,4 +8,5 @@ export declare class SingleValueSelectedForFilterRule implements IRule {
     getName(): string;
     forSearch(dependencies: ISearchDependencies): Promise<boolean>;
     forSitemapGenerator(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
+    getDescription(): string;
 }

package/dist/src/common/rules/SingleValueSelectedForFilterRule.js

@@ -18,4 +18,7 @@ export class SingleValueSelectedForFilterRule {
         }
         return Promise.resolve(true);
     }
+    getDescription() {
+        return `Single value is selected for filter ${this.filterKey}`;
+    }
 }

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

@@ -3,17 +3,37 @@ export declare enum FilterCombinations {
     AREA_ATTENDANCE = "areaAttendance",
     AREA_DISCIPLINE = "areaDiscipline",
     COUNTRY = "country",
+    COUNTRY_DEGREE = "countryDegree",
+    COUNTRY_DURATION = "countryDuration",
+    COUNTRY_FORMAT = "countryFormat",
+    COUNTRY_TUITION_FEE = "countryTuitionFee",
+    COUNTRY_EDUCATIONAL_FORM = "countryEducationalForm",
+    COUNTRY_ATTENDANCE_DEGREE = "countryAttendanceDegree",
+    COUNTRY_DURATION_DEGREE = "countryDurationDegree",
     DISCIPLINE_AREA = "disciplineArea",
     DISCIPLINE_ATTENDANCE = "disciplineAttendance",
     DISCIPLINE_COUNTRY = "disciplineCountry",
+    DISCIPLINE_CONTINENT = "disciplineContinent",
+    DISCIPLINE_DEGREE = "disciplineDegree",
+    DISCIPLINE_DURATION = "disciplineDuration",
+    DISCIPLINE_FORMAT = "disciplineFormat",
+    DISCIPLINE_TUITION_FEE = "disciplineTuitionFee",
+    DISCIPLINE_EDUCATIONAL_FORM = "disciplineEducationalForm",
+    DISCIPLINE_TUITION_FEE_ATTENDANCE = "disciplineTuitionFeeAttendance",
+    DISCIPLINE_COUNTRY_EDUCATIONAL_FORM = "disciplineCountryEducationalForm",
+    DISCIPLINE_COUNTRY_DEGREE = "disciplineCountryDegree",
     DISCIPLINE = "discipline",
     UNFILTERED = "unfiltered",
     UNIVERSITY_COUNTRY = "universityCountry",
     ATTENDANCE_DISCIPLINE = "attendancedDiscipline",
+    ATTENDANCE_DEGREE = "attendanceDegree",
     CONTINENT_ATTENDANCE = "continentAttendance",
     COUNTRY_ATTENDANCE = "countryAttendance",
     ATTENDANCE = "attendance",
     CONTINENT = "continent",
+    CONTINENT_TUITION_FEE = "continentTuitionFee",
+    TUITION_FEE = "tuitionFee",
+    SPECIAL_PROGRAMMES = "specialProgrammes",
     RANKED_AREA = "rankedArea",
     RANKED_AREA_DISCIPLINE = "rankedAreaDiscipline",
     RANKED_ATTENDANCE = "rankedAttendance",

package/dist/src/enums/FilterCombinations.js

@@ -4,17 +4,37 @@ export var FilterCombinations;
     FilterCombinations["AREA_ATTENDANCE"] = "areaAttendance";
     FilterCombinations["AREA_DISCIPLINE"] = "areaDiscipline";
     FilterCombinations["COUNTRY"] = "country";
+    FilterCombinations["COUNTRY_DEGREE"] = "countryDegree";
+    FilterCombinations["COUNTRY_DURATION"] = "countryDuration";
+    FilterCombinations["COUNTRY_FORMAT"] = "countryFormat";
+    FilterCombinations["COUNTRY_TUITION_FEE"] = "countryTuitionFee";
+    FilterCombinations["COUNTRY_EDUCATIONAL_FORM"] = "countryEducationalForm";
+    FilterCombinations["COUNTRY_ATTENDANCE_DEGREE"] = "countryAttendanceDegree";
+    FilterCombinations["COUNTRY_DURATION_DEGREE"] = "countryDurationDegree";
     FilterCombinations["DISCIPLINE_AREA"] = "disciplineArea";
     FilterCombinations["DISCIPLINE_ATTENDANCE"] = "disciplineAttendance";
     FilterCombinations["DISCIPLINE_COUNTRY"] = "disciplineCountry";
+    FilterCombinations["DISCIPLINE_CONTINENT"] = "disciplineContinent";
+    FilterCombinations["DISCIPLINE_DEGREE"] = "disciplineDegree";
+    FilterCombinations["DISCIPLINE_DURATION"] = "disciplineDuration";
+    FilterCombinations["DISCIPLINE_FORMAT"] = "disciplineFormat";
+    FilterCombinations["DISCIPLINE_TUITION_FEE"] = "disciplineTuitionFee";
+    FilterCombinations["DISCIPLINE_EDUCATIONAL_FORM"] = "disciplineEducationalForm";
+    FilterCombinations["DISCIPLINE_TUITION_FEE_ATTENDANCE"] = "disciplineTuitionFeeAttendance";
+    FilterCombinations["DISCIPLINE_COUNTRY_EDUCATIONAL_FORM"] = "disciplineCountryEducationalForm";
+    FilterCombinations["DISCIPLINE_COUNTRY_DEGREE"] = "disciplineCountryDegree";
     FilterCombinations["DISCIPLINE"] = "discipline";
     FilterCombinations["UNFILTERED"] = "unfiltered";
     FilterCombinations["UNIVERSITY_COUNTRY"] = "universityCountry";
     FilterCombinations["ATTENDANCE_DISCIPLINE"] = "attendancedDiscipline";
+    FilterCombinations["ATTENDANCE_DEGREE"] = "attendanceDegree";
     FilterCombinations["CONTINENT_ATTENDANCE"] = "continentAttendance";
     FilterCombinations["COUNTRY_ATTENDANCE"] = "countryAttendance";
     FilterCombinations["ATTENDANCE"] = "attendance";
     FilterCombinations["CONTINENT"] = "continent";
+    FilterCombinations["CONTINENT_TUITION_FEE"] = "continentTuitionFee";
+    FilterCombinations["TUITION_FEE"] = "tuitionFee";
+    FilterCombinations["SPECIAL_PROGRAMMES"] = "specialProgrammes";
     FilterCombinations["RANKED_AREA"] = "rankedArea";
     FilterCombinations["RANKED_AREA_DISCIPLINE"] = "rankedAreaDiscipline";
     FilterCombinations["RANKED_ATTENDANCE"] = "rankedAttendance";

package/dist/src/organisations/OrganisationsRuleBasedIndexabilityPolicy.d.ts

@@ -0,0 +1,11 @@
+import { PortalType } from '@studyportals/domain-client';
+import { IOrganisationsSeoDependencies } from './types/IOrganisationsSeoDependencies';
+import { SortingOptions } from '../enums/SortingOptions';
+import { BaseSeoIndexabilityPolicy } from '../common/policies/BaseSeoIndexabilityPolicy';
+export declare abstract class OrganisationsRuleBasedIndexabilityPolicy extends BaseSeoIndexabilityPolicy<IOrganisationsSeoDependencies> {
+    protected readonly indexablePortalTypes: PortalType[];
+    protected abstract readonly sortingOption: SortingOptions;
+    constructor(dependencies: IOrganisationsSeoDependencies);
+    protected isIndexable(): Promise<boolean>;
+    private matchesSortingOption;
+}

package/dist/src/organisations/OrganisationsRuleBasedIndexabilityPolicy.js

@@ -0,0 +1,19 @@
+import { PortalType } from '@studyportals/domain-client';
+import { BaseSeoIndexabilityPolicy } from '../common/policies/BaseSeoIndexabilityPolicy';
+export class OrganisationsRuleBasedIndexabilityPolicy extends BaseSeoIndexabilityPolicy {
+    indexablePortalTypes = [PortalType.MASTER];
+    constructor(dependencies) {
+        super(dependencies);
+    }
+    async isIndexable() {
+        const isIndexable = await super.isIndexable();
+        if (!isIndexable) {
+            return false;
+        }
+        return this.indexablePortalTypes.includes(this.dependencies.portalType) && this.matchesSortingOption();
+    }
+    matchesSortingOption() {
+        const dependencies = this.dependencies;
+        return dependencies.sortingState.getSelectedOption() === this.sortingOption;
+    }
+}

package/dist/src/organisations/SearchIndexabilityManager.d.ts

@@ -8,4 +8,5 @@ export declare class SearchIndexabilityManager implements ISearchIndexabilityMan
     policies: ISeoIndexabilityPolicy[];
     constructor(portalType: PortalType, seoInfoBase: ISeoInfoBase, filterState: ISeoFilterState, sortingState: ISeoSortingState, applicationState: IOrganisationSearchApplicationState);
     shouldIndex(): Promise<boolean>;
+    getPolicies(): ISeoIndexabilityPolicy[];
 }

package/dist/src/organisations/SearchIndexabilityManager.js

@@ -36,4 +36,7 @@ export class SearchIndexabilityManager {
         const results = await Promise.all(this.policies.map((policy) => policy.shouldIndex()));
         return results.some((result) => result);
     }
+    getPolicies() {
+        return this.policies;
+    }
 }

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

@@ -5,7 +5,6 @@ import { SortingOptions } from '../../enums/SortingOptions';
 export declare abstract class OrganisationsSeoIndexabilityPolicy extends BaseSeoIndexabilityPolicy<IOrganisationsSeoDependencies> {
     protected readonly indexablePortalTypes: PortalType[];
     protected abstract readonly sortingOption: SortingOptions;
-    constructor(dependencies: IOrganisationsSeoDependencies);
     generateSitemapUrls(): Promise<string[]>;
     protected isIndexable(): Promise<boolean>;
     protected getPathWithSortingOption(path: string): string;

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

@@ -2,9 +2,6 @@ import { PortalType } from '@studyportals/domain-client';
 import { BaseSeoIndexabilityPolicy } from '../../common/policies/BaseSeoIndexabilityPolicy';
 export class OrganisationsSeoIndexabilityPolicy extends BaseSeoIndexabilityPolicy {
     indexablePortalTypes = [PortalType.MASTER];
-    constructor(dependencies) {
-        super(dependencies);
-    }
     async generateSitemapUrls() {
         if (this.indexablePortalTypes.includes(this.dependencies.portalType)) {
             return super.generateSitemapUrls();

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

@@ -1,6 +1,8 @@
+import { PortalType } from '@studyportals/domain-client';
 import { SortingOptions } from '../../enums/SortingOptions';
 import { OrganisationsSeoIndexabilityPolicy } from './OrganisationsSeoIndexabilityPolicy';
 export declare abstract class RankedOrganisationsSeoIndexabilityPolicy extends OrganisationsSeoIndexabilityPolicy {
+    protected readonly indexablePortalTypes: PortalType[];
     protected readonly sortingOption: SortingOptions;
     protected addRankedResultsCountRule(): void;
     protected getPathWithSortingOption(path: string): string;

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

@@ -1,7 +1,9 @@
+import { PortalType } from '@studyportals/domain-client';
 import { SortingOptions } from '../../enums/SortingOptions';
 import { OrganisationsSeoIndexabilityPolicy } from './OrganisationsSeoIndexabilityPolicy';
 import { AtLeastTwoRankedResultsRule } from '../rules/AtLeastTwoRankedResultsRule';
 export class RankedOrganisationsSeoIndexabilityPolicy extends OrganisationsSeoIndexabilityPolicy {
+    indexablePortalTypes = [PortalType.MASTER];
     sortingOption = SortingOptions.UNIVERSITY_META_RANKING;
     addRankedResultsCountRule() {
         let rankedResultsCountRule;

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

@@ -4,6 +4,8 @@ import { SingleValueSelectedForFilterRule } from '../../../common/rules/SingleVa
 import { OrganisationsSeoIndexabilityPolicy } from '../../../organisations/policies/OrganisationsSeoIndexabilityPolicy';
 import { OnlyFiltersSelectedRule } from '../../../common/rules/OnlyFiltersSelectedRule';
 export declare class Area extends OrganisationsSeoIndexabilityPolicy {
+    readonly name: string;
+    readonly description: string;
     protected readonly sortingOption = SortingOptions.OUR_PICKS;
     protected readonly rules: (SingleValueSelectedForFilterRule | OnlyFiltersSelectedRule)[];
     protected generateUrls(): Promise<string[]>;

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

@@ -6,6 +6,8 @@ import { OrganisationsSeoIndexabilityPolicy } from '../../../organisations/polic
 import { OnlyFiltersSelectedRule } from '../../../common/rules/OnlyFiltersSelectedRule';
 import { AreaPresenter } from '../../../presenters/AreaPresenter';
 export class Area extends OrganisationsSeoIndexabilityPolicy {
+    name = 'Area Policy';
+    description = 'Controls indexing of pages filtered by geographic areas, ensuring only SEO-valuable regional content with sufficient search volume is indexed.';
     sortingOption = SortingOptions.OUR_PICKS;
     rules = [
         new SingleValueSelectedForFilterRule(FilterKey.AREA),

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

@@ -4,10 +4,12 @@ import { SearchVolumeAreasAttendanceRule } from '../../../organisations/rules/Se
 import { SortingOptions } from '../../../enums/SortingOptions';
 import { SingleValueSelectedForFilterRule } from '../../../common/rules/SingleValueSelectedForFilterRule';
 import { OnlyFiltersSelectedRule } from '../../../common/rules/OnlyFiltersSelectedRule';
-import { OnlineAttendanceRule } from '../../../organisations/rules/OnlineAttendanceRule';
+import { OnlineAttendanceRule } from '../../../common/rules/OnlineAttendanceRule';
 export declare class AreaAttendance extends OrganisationsSeoIndexabilityPolicy {
+    readonly name: string;
+    readonly description: string;
     protected readonly sortingOption = SortingOptions.OUR_PICKS;
-    protected readonly rules: (SingleValueSelectedForFilterRule | OnlyFiltersSelectedRule | SearchVolumeAreasAttendanceRule | OnlineAttendanceRule)[];
+    protected readonly rules: (SingleValueSelectedForFilterRule | OnlyFiltersSelectedRule | OnlineAttendanceRule | SearchVolumeAreasAttendanceRule)[];
     protected generateUrls(): Promise<string[]>;
     get filterCombination(): FilterCombinations;
 }

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

@@ -5,10 +5,12 @@ import { SearchVolumeAreasAttendanceRule } from '../../../organisations/rules/Se
 import { SortingOptions } from '../../../enums/SortingOptions';
 import { SingleValueSelectedForFilterRule } from '../../../common/rules/SingleValueSelectedForFilterRule';
 import { OnlyFiltersSelectedRule } from '../../../common/rules/OnlyFiltersSelectedRule';
-import { OnlineAttendanceRule } from '../../../organisations/rules/OnlineAttendanceRule';
+import { OnlineAttendanceRule } from '../../../common/rules/OnlineAttendanceRule';
 import { AreaPresenter } from '../../../presenters/AreaPresenter';
 import { AttendancePresenter } from '../../../presenters/AttendancePresenter';
 export class AreaAttendance extends OrganisationsSeoIndexabilityPolicy {
+    name = 'Area Attendance Policy';
+    description = 'Manages indexability for pages filtered by both geographic area and attendance type, optimizing for region-specific study format combinations.';
     sortingOption = SortingOptions.OUR_PICKS;
     rules = [
         new SingleValueSelectedForFilterRule(FilterKey.AREA),

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

@@ -3,8 +3,10 @@ import { SortingOptions } from '../../../enums/SortingOptions';
 import { OrganisationsSeoIndexabilityPolicy } from '../../../organisations/policies/OrganisationsSeoIndexabilityPolicy';
 import { SingleValueSelectedForFilterRule } from '../../../common/rules/SingleValueSelectedForFilterRule';
 import { OnlyFiltersSelectedRule } from '../../../common/rules/OnlyFiltersSelectedRule';
-import { OnlineAttendanceRule } from '../../../organisations/rules/OnlineAttendanceRule';
+import { OnlineAttendanceRule } from '../../../common/rules/OnlineAttendanceRule';
 export declare class Attendance extends OrganisationsSeoIndexabilityPolicy {
+    readonly name: string;
+    readonly description: string;
     protected readonly sortingOption = SortingOptions.OUR_PICKS;
     protected readonly rules: (SingleValueSelectedForFilterRule | OnlyFiltersSelectedRule | OnlineAttendanceRule)[];
     protected generateUrls(): Promise<string[]>;

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

@@ -4,9 +4,11 @@ import { SortingOptions } from '../../../enums/SortingOptions';
 import { OrganisationsSeoIndexabilityPolicy } from '../../../organisations/policies/OrganisationsSeoIndexabilityPolicy';
 import { SingleValueSelectedForFilterRule } from '../../../common/rules/SingleValueSelectedForFilterRule';
 import { OnlyFiltersSelectedRule } from '../../../common/rules/OnlyFiltersSelectedRule';
-import { OnlineAttendanceRule } from '../../../organisations/rules/OnlineAttendanceRule';
+import { OnlineAttendanceRule } from '../../../common/rules/OnlineAttendanceRule';
 import { AttendancePresenter } from '../../../presenters/AttendancePresenter';
 export class Attendance extends OrganisationsSeoIndexabilityPolicy {
+    name = 'Attendance Policy';
+    description = 'Determines indexing rules for pages filtered by study format (online, on-campus, etc.), prioritizing formats with demonstrated search demand.';
     sortingOption = SortingOptions.OUR_PICKS;
     rules = [
         new SingleValueSelectedForFilterRule(FilterKey.DELIVERY_METHOD),

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

@@ -4,6 +4,8 @@ import { OrganisationsSeoIndexabilityPolicy } from '../../../organisations/polic
 import { SingleValueSelectedForFilterRule } from '../../../common/rules/SingleValueSelectedForFilterRule';
 import { OnlyFiltersSelectedRule } from '../../../common/rules/OnlyFiltersSelectedRule';
 export declare class Continent extends OrganisationsSeoIndexabilityPolicy {
+    readonly name: string;
+    readonly description: string;
     protected readonly sortingOption = SortingOptions.OUR_PICKS;
     protected readonly rules: (SingleValueSelectedForFilterRule | OnlyFiltersSelectedRule)[];
     get filterCombination(): FilterCombinations;

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

@@ -6,6 +6,8 @@ import { SingleValueSelectedForFilterRule } from '../../../common/rules/SingleVa
 import { OnlyFiltersSelectedRule } from '../../../common/rules/OnlyFiltersSelectedRule';
 import { ContinentPresenter } from '../../../presenters/ContinentPresenter';
 export class Continent extends OrganisationsSeoIndexabilityPolicy {
+    name = 'Continent Policy';
+    description = 'Governs indexing of continent-level filtered pages, applying rules to index only continental regions with sufficient search volume and content density.';
     sortingOption = SortingOptions.OUR_PICKS;
     rules = [
         new SingleValueSelectedForFilterRule(FilterKey.CONTINENT),