@studyportals/fawkes 7.3.5 → 7.4.0-beta.0

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/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/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.js

@@ -8,7 +8,7 @@ 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 = [

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

@@ -0,0 +1,16 @@
+import { FilterKey } from '@studyportals/search-filters';
+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';
+export declare class DisciplineCountryDegree extends ProgrammesBaseIndexabilityPolicy {
+    readonly name: string;
+    readonly description: string;
+    readonly filterKeys: FilterKey[];
+    protected readonly rules: (SingleValueSelectedForFilterRule | OnlyFiltersSelectedRule | IndexableDegreeRule)[];
+    constructor(dependencies: IProgrammeSeoDependencies);
+    protected generateUrls(): Promise<string[]>;
+    get filterCombination(): FilterCombinations;
+}

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

@@ -0,0 +1,53 @@
+import { FilterKey } from '@studyportals/search-filters';
+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 { DisciplinePresenter } from '../../presenters/DisciplinePresenter';
+import { CountryPresenter } from '../../presenters/CountryPresenter';
+import { DegreePresenter } from '../../presenters/DegreePresenter';
+export class DisciplineCountryDegree extends ProgrammesBaseIndexabilityPolicy {
+    name = 'Discipline Country Degree Policy';
+    description = `Determines indexing rules for pages filtered by discipline,
+		country, and degree type.`;
+    filterKeys = [FilterKey.DISCIPLINES, FilterKey.COUNTRY, FilterKey.DEGREE_TYPE];
+    rules = [
+        new SingleValueSelectedForFilterRule(FilterKey.DISCIPLINES),
+        new SingleValueSelectedForFilterRule(FilterKey.COUNTRY),
+        new SingleValueSelectedForFilterRule(FilterKey.DEGREE_TYPE),
+        new OnlyFiltersSelectedRule([FilterKey.DISCIPLINES, FilterKey.COUNTRY, FilterKey.DEGREE_TYPE]),
+        new IndexableDegreeRule()
+    ];
+    constructor(dependencies) {
+        super(dependencies);
+        this.initateBaseRules();
+    }
+    async generateUrls() {
+        const disciplineFragments = DisciplinePresenter.getInstance().getFragments();
+        const countryFragments = CountryPresenter.getInstance().getFragments();
+        const degreeFragments = DegreePresenter.getInstance().getFragments();
+        const paths = [];
+        for (const pageNumber of this.indexablePageNumbers) {
+            for (const discipline of disciplineFragments) {
+                for (const country of countryFragments) {
+                    for (const degree of degreeFragments) {
+                        const filterKeyValues = new Map([
+                            [FilterKey.DISCIPLINES, [discipline.id]],
+                            [FilterKey.COUNTRY, [country.id]],
+                            [FilterKey.DEGREE_TYPE, [degree.id]]
+                        ]);
+                        const result = await this.checkRulesForSitemapWithPageNumber(filterKeyValues, pageNumber);
+                        if (result) {
+                            paths.push(this.getPathWithPageNumber(`${degree.path}/${discipline.path}/${country.path}`, pageNumber));
+                        }
+                    }
+                }
+            }
+        }
+        return paths;
+    }
+    get filterCombination() {
+        return FilterCombinations.DISCIPLINE_COUNTRY_DEGREE;
+    }
+}

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

@@ -9,7 +9,7 @@ import { CountryPresenter } from '../../presenters/CountryPresenter';
 import { EducationalFormPresenter } from '../../presenters/EducationalFormPresenter';
 export class DisciplineCountryEducationalForm extends ProgrammesBaseIndexabilityPolicy {
     name = 'Discipline Country Educational Form Policy';
-    description = `Determines indexing rules for pages filtered by discipline,
+    description = `Determines indexing rules for pages filtered by discipline,
 		country, and educational form (academic, semester, summer school, etc.).`;
     filterKeys = [FilterKey.DISCIPLINES, FilterKey.COUNTRY, FilterKey.EDUCATIONAL_FORM];
     rules = [

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

@@ -8,7 +8,7 @@ import { DisciplinePresenter } from '../../presenters/DisciplinePresenter';
 import { EducationalFormPresenter } from '../../presenters/EducationalFormPresenter';
 export class DisciplineEducationalForm extends ProgrammesBaseIndexabilityPolicy {
     name = 'Discipline Educational Form Policy';
-    description = `Determines indexing rules for pages filtered by both discipline,
+    description = `Determines indexing rules for pages filtered by both discipline,
 		and educational form (academic, semester, summer school, etc.).`;
     filterKeys = [FilterKey.DISCIPLINES, FilterKey.EDUCATIONAL_FORM];
     rules = [

package/dist/src/structured-data/ProgrammeStructuredDataFactory.d.ts

@@ -11,7 +11,7 @@ export declare class ProgrammeStructuredDataFactory extends SearchStructuredData
     private regionalDataPriority;
     protected getRating(card: IProgrammeCard): ReviewRatingDTO | undefined;
     protected getOfferData(card: IProgrammeCard): Promise<OfferDTO | undefined>;
-    protected buildStructuredDataForCard(entity: EntityDTO<IProgrammeCard>): Course;
+    protected buildStructuredDataForCard(entity: EntityDTO<IProgrammeCard>): Course | undefined;
     private getCourseMode;
     private getCourseWorkload;
     private getCourseStartDate;

package/dist/src/structured-data/ProgrammeStructuredDataFactory.js

@@ -35,12 +35,15 @@ export class ProgrammeStructuredDataFactory extends SearchStructuredDataFactory
             return;
         }
         return {
-            price: await this.currencyConversionService.convert(tuition.getAmount(), tuition.getCurrency(), 'USD'),
+            price: Math.round(await this.currencyConversionService.convert(tuition.getAmount(), tuition.getCurrency(), 'USD')),
             category: 'tuition',
             validFrom: timing ? timing.getStartDate().getDate() : undefined
         };
     }
     buildStructuredDataForCard(entity) {
+        const offer = this.constructOffer(entity.offer);
+        if (!offer)
+            return undefined;
         const card = entity.card;
         return {
             "@type": "Course",
@@ -52,7 +55,7 @@ export class ProgrammeStructuredDataFactory extends SearchStructuredDataFactory
                 "name": card.getUniversityLink().getDescription(),
                 "url": `https://${window.location.host}${card.getUniversityLink().getUrl()}`
             },
-            "offers": this.constructOffer(entity.offer),
+            "offers": offer,
             "aggregateRating": this.constructAggregateRating(entity.reviewRating),
             "hasCourseInstance": {
                 "@type": "CourseInstance",

package/dist/src/structured-data/SearchStructuredDataFactory.d.ts

@@ -1,12 +1,12 @@
-import { SearchResultsPage, WithContext, Offer, AggregateRating, Thing, FAQPage } from "schema-dts";
-import { ReviewRatingDTO } from "./dto/ReviewRatingDTO";
-import { OfferDTO } from "./dto/OfferDTO";
-import { EntityDTO } from "./dto/EntityDTO";
-import { FAQItemDto } from "./dto/FAQItemDto";
-import { BreadcrumbDTO } from "./dto/BreadcrumbDTO";
+import { SearchResultsPage, WithContext, Offer, AggregateRating, Thing, FAQPage } from 'schema-dts';
+import { ReviewRatingDTO } from './dto/ReviewRatingDTO';
+import { OfferDTO } from './dto/OfferDTO';
+import { EntityDTO } from './dto/EntityDTO';
+import { FAQItemDto } from './dto/FAQItemDto';
+import { BreadcrumbDTO } from './dto/BreadcrumbDTO';
 export declare abstract class SearchStructuredDataFactory<TCard> {
     buildStructuredData(title: string, description: string, cards: TCard[], faqItems?: FAQItemDto[], breadcrumbs?: BreadcrumbDTO[]): Promise<WithContext<SearchResultsPage>>;
-    protected abstract buildStructuredDataForCard(entity: EntityDTO<TCard>): Thing;
+    protected abstract buildStructuredDataForCard(entity: EntityDTO<TCard>): Thing | undefined;
     /**
      * Get the rating for a card.
      * This method should be overridden by subclasses to provide the specific rating logic.
@@ -25,7 +25,6 @@ export declare abstract class SearchStructuredDataFactory<TCard> {
      * @protected
      */
     protected getOfferData(card: TCard): Promise<OfferDTO | undefined>;
-    private constructOptionalPageAggregateRating;
     private constructOptionalPageOffers;
     protected constructOptionalFaqPage(faqItems: FAQItemDto[]): FAQPage | undefined;
     private constructOptionalBreadcrumbs;

package/dist/src/structured-data/SearchStructuredDataFactory.js

@@ -12,14 +12,16 @@ export class SearchStructuredDataFactory {
                 offersData.push(offer);
             entities.push({ card, offer, reviewRating });
         }
+        const mainEntities = entities
+            .map(entity => this.buildStructuredDataForCard(entity))
+            .filter(entity => entity !== undefined);
         const data = {
-            "@context": "https://schema.org",
-            "@type": "SearchResultsPage",
-            "name": title,
+            '@context': 'https://schema.org',
+            '@type': 'SearchResultsPage',
+            'name': title,
             description,
-            "mainEntity": entities.map(entity => this.buildStructuredDataForCard(entity))
+            'mainEntity': mainEntities
         };
-        data.aggregateRating = this.constructOptionalPageAggregateRating(ratings);
         data.offers = this.constructOptionalPageOffers(offersData);
         data.hasPart = this.constructOptionalFaqPage(faqItems);
         data.breadcrumb = this.constructOptionalBreadcrumbs(breadcrumbs);
@@ -49,18 +51,6 @@ export class SearchStructuredDataFactory {
     async getOfferData(card) {
         return undefined;
     }
-    constructOptionalPageAggregateRating(ratings) {
-        if (ratings.length <= 0)
-            return;
-        let totalQuantity = 0;
-        let totalRatingValue = 0;
-        for (const rating of ratings) {
-            totalQuantity += rating.quantity;
-            totalRatingValue += rating.rating;
-        }
-        const totalAverageRating = Math.round((totalRatingValue / ratings.length) * 10) / 10;
-        return this.constructAggregateRating({ rating: totalAverageRating, quantity: totalQuantity });
-    }
     constructOptionalPageOffers(offersData) {
         if (offersData.length <= 0)
             return;
@@ -77,15 +67,15 @@ export class SearchStructuredDataFactory {
             totalPrice += offer.price;
         }
         return {
-            "@type": "AggregateOffer",
-            "lowPrice": Math.max(minPrice, 0),
-            "highPrice": maxPrice,
-            "priceCurrency": "USD",
-            "offerCount": offersData.length,
-            "priceSpecification": {
-                "@type": "PriceSpecification",
-                "price": Math.round(totalPrice / offersData.length),
-                "priceCurrency": "USD"
+            '@type': 'AggregateOffer',
+            'lowPrice': Math.max(minPrice, 0),
+            'highPrice': maxPrice,
+            'priceCurrency': 'USD',
+            'offerCount': offersData.length,
+            'priceSpecification': {
+                '@type': 'PriceSpecification',
+                'price': Math.round(totalPrice / offersData.length),
+                'priceCurrency': 'USD'
             }
         };
     }
@@ -93,13 +83,13 @@ export class SearchStructuredDataFactory {
         if (faqItems.length <= 0)
             return;
         return {
-            "@type": "FAQPage",
-            "mainEntity": faqItems.map(item => ({
-                "@type": "Question",
-                "name": item.question,
-                "acceptedAnswer": {
-                    "@type": "Answer",
-                    "text": this.stripHtmlWithListRetain(item.answer)
+            '@type': 'FAQPage',
+            'mainEntity': faqItems.map(item => ({
+                '@type': 'Question',
+                'name': item.question,
+                'acceptedAnswer': {
+                    '@type': 'Answer',
+                    'text': this.stripHtmlWithListRetain(item.answer)
                 }
             }))
         };
@@ -108,13 +98,13 @@ export class SearchStructuredDataFactory {
         if (breadcrumbs.length <= 0)
             return;
         return {
-            "@type": "BreadcrumbList",
-            "itemListElement": breadcrumbs.map((breadcrumb) => ({
-                "@type": "ListItem",
-                "@id": `${breadcrumb.url}#listitem#thing`,
-                "name": breadcrumb.name,
-                "position": breadcrumb.position,
-                "item": breadcrumb.url
+            '@type': 'BreadcrumbList',
+            'itemListElement': breadcrumbs.map((breadcrumb) => ({
+                '@type': 'ListItem',
+                '@id': `${breadcrumb.url}#listitem#thing`,
+                'name': breadcrumb.name,
+                'position': breadcrumb.position,
+                'item': breadcrumb.url
             }))
         };
     }
@@ -122,23 +112,23 @@ export class SearchStructuredDataFactory {
         if (!reviewRating)
             return;
         return {
-            "@type": "AggregateRating",
-            "ratingValue": reviewRating.rating,
-            "reviewCount": reviewRating.quantity,
-            "bestRating": 5,
-            "worstRating": 1
+            '@type': 'AggregateRating',
+            'ratingValue': reviewRating.rating,
+            'reviewCount': reviewRating.quantity,
+            'bestRating': 5,
+            'worstRating': 1
         };
     }
     constructOffer(offerData) {
         if (!offerData)
             return;
         return {
-            "@type": "Offer",
-            "price": offerData.price,
-            "priceCurrency": "USD",
-            "availability": "https://schema.org/InStock",
-            "validFrom": offerData.validFrom ? offerData.validFrom.toISOString().split('T')[0] : undefined,
-            "category": "tuition"
+            '@type': 'Offer',
+            'price': offerData.price,
+            'priceCurrency': 'USD',
+            'availability': 'https://schema.org/InStock',
+            'validFrom': offerData.validFrom ? offerData.validFrom.toISOString().split('T')[0] : undefined,
+            'category': 'tuition'
         };
     }
     stripHtmlWithListRetain(html) {

package/package.json

@@ -1,105 +1,105 @@
-{
-	"name": "@studyportals/fawkes",
-	"version": "7.3.5",
-	"description": "A package to centralize SEO related logic for SBLP and Sitemap Generator.",
-	"files": [
-		"./dist"
-	],
-	"scripts": {
-		"prepush": "npm run test",
-		"precommit": "npm run lint",
-		"compile": "npx tsc && tsc-alias && rm -r ./dist/tests",
-		"build": "npm run clean && npm run compile",
-		"clean": "rimraf \"!(node_modules)/**/dist\"",
-		"prepare-deployment": "npm run test && npm run build",
-		"publish-major": "npm run prepare-deployment && npm version major && npm publish",
-		"publish-beta": "npm run prepare-deployment && npm version prerelease && npm publish --tag beta --access=public",
-		"publish-patch": "npm run prepare-deployment && npm version patch && npm publish",
-		"publish-minor": "npm run prepare-deployment && npm version minor && npm publish",
-		"prepare": "husky install",
-		"test": "vitest run --coverage",
-		"test:dev": "vitest --coverage tests/programmes",
-		"lint": "eslint . --ext .ts",
-		"lint:fix": "eslint . --ext .ts --fix",
-		"prettier:fix": "npx prettier --use-tabs --ignore-path .gitignore --write ."
-	},
-	"exports": {
-		"./organisations-search-seo": {
-			"import": "./dist/organisations-seo/index.js",
-			"require": "./dist/organisations-seo/index.js",
-			"types": "./dist/organisations-seo/index.d.ts"
-		},
-		"./programmes-search-seo": {
-			"import": "./dist/programmes-seo/index.js",
-			"require": "./dist/programmes-seo/index.js",
-			"types": "./dist/programmes-seo/index.d.ts"
-		},
-		"./scholarships-search-seo": {
-			"import": "./dist/scholarships-seo/index.js",
-			"require": "./dist/scholarships-seo/index.js",
-			"types": "./dist/scholarships-seo/index.d.ts"
-		},
-		"./sitemap-generator-seo": {
-			"import": "./dist/sitemap-generator-seo/index.js",
-			"require": "./dist/sitemap-generator-seo/index.js",
-			"types": "./dist/sitemap-generator-seo/index.d.ts"
-		},
-		"./structured-data-seo": {
-			"import": "./dist/structured-data-seo/index.js",
-			"require": "./dist/structured-data-seo/index.js",
-			"types": "./dist/structured-data-seo/index.d.ts"
-		}
-	},
-	"typesVersions": {
-		"*": {
-			"organisations-search-seo": [
-				"dist/organisations-seo/index.d.ts"
-			],
-			"programmes-search-seo": [
-				"dist/programmes-seo/index.d.ts"
-			],
-			"scholarships-search-seo": [
-				"dist/scholarships-seo/index.d.ts"
-			],
-			"sitemap-generator-seo": [
-				"dist/sitemap-generator-seo/index.d.ts"
-			],
-			"structured-data-seo": [
-				"dist/structured-data-seo/index.d.ts"
-			],
-			"*": [
-				"dist/index.d.ts"
-			]
-		}
-	},
-	"author": "The Jedi Council",
-	"license": "ISC",
-	"devDependencies": {
-		"@adobe/structured-data-validator": "^1.4.1",
-		"@studyportals/code-style": "^2.2.1",
-		"@studyportals/webpack-helper": "^6.0.6",
-		"@vitest/coverage-istanbul": "^2.1.8",
-		"husky": "^8.0.3",
-		"jsdom": "^26.0.0",
-		"prettier": "^3.5.3",
-		"tsc-alias": "^1.8.11",
-		"typemoq": "^2.1.0",
-		"typescript": "^5.7.3",
-		"vitest": "^2.1.8",
-      	"schema-dts": "^1.1.5",
-      	"ts-loader": "^9.5.2"
-	},
-	"dependencies": {
-		"@studyportals/domain-client": "^6.2.0",
-		"@studyportals/ranking-api-interface": "^1.3.12",
-		"@studyportals/search-filters": "^4.9.1",
-		"@studyportals/static-domain-data": "^6.1.0"
-	},
-	"optionalDependencies": {
-		"@rollup/rollup-linux-x64-gnu": "4.24.0"
-	},
-	"engines": {
-		"node": ">=18 <=22",
-		"npm": ">=8 <=10"
-	}
-}
+{
+	"name": "@studyportals/fawkes",
+	"version": "7.4.0-beta.0",
+	"description": "A package to centralize SEO related logic for SBLP and Sitemap Generator.",
+	"files": [
+		"./dist"
+	],
+	"scripts": {
+		"prepush": "npm run test",
+		"precommit": "npm run lint",
+		"compile": "npx tsc && tsc-alias && rm -r ./dist/tests",
+		"build": "npm run clean && npm run compile",
+		"clean": "rimraf \"!(node_modules)/**/dist\"",
+		"prepare-deployment": "npm run test && npm run build",
+		"publish-major": "npm run prepare-deployment && npm version major && npm publish",
+		"publish-beta": "npm run prepare-deployment && npm publish --tag beta --access=public",
+		"publish-patch": "npm run prepare-deployment && npm version patch && npm publish",
+		"publish-minor": "npm run prepare-deployment && npm version minor && npm publish",
+		"prepare": "husky install",
+		"test": "vitest run --coverage",
+		"test:dev": "vitest --coverage tests/programmes",
+		"lint": "eslint . --ext .ts",
+		"lint:fix": "eslint . --ext .ts --fix",
+		"prettier:fix": "npx prettier --use-tabs --ignore-path .gitignore --write ."
+	},
+	"exports": {
+		"./organisations-search-seo": {
+			"import": "./dist/organisations-seo/index.js",
+			"require": "./dist/organisations-seo/index.js",
+			"types": "./dist/organisations-seo/index.d.ts"
+		},
+		"./programmes-search-seo": {
+			"import": "./dist/programmes-seo/index.js",
+			"require": "./dist/programmes-seo/index.js",
+			"types": "./dist/programmes-seo/index.d.ts"
+		},
+		"./scholarships-search-seo": {
+			"import": "./dist/scholarships-seo/index.js",
+			"require": "./dist/scholarships-seo/index.js",
+			"types": "./dist/scholarships-seo/index.d.ts"
+		},
+		"./sitemap-generator-seo": {
+			"import": "./dist/sitemap-generator-seo/index.js",
+			"require": "./dist/sitemap-generator-seo/index.js",
+			"types": "./dist/sitemap-generator-seo/index.d.ts"
+		},
+		"./structured-data-seo": {
+			"import": "./dist/structured-data-seo/index.js",
+			"require": "./dist/structured-data-seo/index.js",
+			"types": "./dist/structured-data-seo/index.d.ts"
+		}
+	},
+	"typesVersions": {
+		"*": {
+			"organisations-search-seo": [
+				"dist/organisations-seo/index.d.ts"
+			],
+			"programmes-search-seo": [
+				"dist/programmes-seo/index.d.ts"
+			],
+			"scholarships-search-seo": [
+				"dist/scholarships-seo/index.d.ts"
+			],
+			"sitemap-generator-seo": [
+				"dist/sitemap-generator-seo/index.d.ts"
+			],
+			"structured-data-seo": [
+				"dist/structured-data-seo/index.d.ts"
+			],
+			"*": [
+				"dist/index.d.ts"
+			]
+		}
+	},
+	"author": "The Jedi Council",
+	"license": "ISC",
+	"devDependencies": {
+		"@adobe/structured-data-validator": "^1.4.1",
+		"@studyportals/code-style": "^2.2.1",
+		"@studyportals/webpack-helper": "^6.0.6",
+		"@vitest/coverage-istanbul": "^2.1.8",
+		"husky": "^8.0.3",
+		"jsdom": "^26.0.0",
+		"prettier": "^3.5.3",
+		"tsc-alias": "^1.8.11",
+		"typemoq": "^2.1.0",
+		"typescript": "^5.7.3",
+		"vitest": "^2.1.8",
+		"schema-dts": "^1.1.5",
+		"ts-loader": "^9.5.2"
+	},
+	"dependencies": {
+		"@studyportals/domain-client": "^6.2.0",
+		"@studyportals/ranking-api-interface": "^1.3.12",
+		"@studyportals/search-filters": "5.1.0-beta.0",
+		"@studyportals/static-domain-data": "^6.1.0"
+	},
+	"optionalDependencies": {
+		"@rollup/rollup-linux-x64-gnu": "4.24.0"
+	},
+	"engines": {
+		"node": ">=18 <=22",
+		"npm": ">=8 <=10"
+	}
+}

package/dist/structured-data/index.d.ts

@@ -1 +0,0 @@
-export * from '../src/structured-data';

package/dist/structured-data/index.js

@@ -1 +0,0 @@
-export * from '../src/structured-data';

package/dist/structured-markup-seo/index.d.ts

@@ -1 +0,0 @@
-export * from '../src/structured-data';

package/dist/structured-markup-seo/index.js

@@ -1 +0,0 @@
-export * from '../src/structured-data';