@studyportals/fawkes 8.1.3-2 → 8.1.3-4

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

@@ -5,7 +5,6 @@ import { IScholarshipCard } from "@studyportals/domain-client";
 import { EntityDTO, OfferDTO, PaywallDTO } from "./dto";
 export declare class ScholarshipStructuredDataFactory extends SearchStructuredDataFactory<IScholarshipCard> {
     private currencyConversionService;
-    private cardIndex;
     constructor(currencyConversionService: StructuredDataCurrencyConversionService);
     protected buildStructuredDataForCard(entity: EntityDTO<IScholarshipCard>): Promise<MonetaryGrant | undefined>;
     protected getOfferData(card: IScholarshipCard): Promise<OfferDTO | undefined>;

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

@@ -1,7 +1,6 @@
 import { SearchStructuredDataFactory } from "./SearchStructuredDataFactory";
 export class ScholarshipStructuredDataFactory extends SearchStructuredDataFactory {
     currencyConversionService;
-    cardIndex = 0;
     constructor(currencyConversionService) {
         super();
         this.currencyConversionService = currencyConversionService;
@@ -32,12 +31,7 @@ export class ScholarshipStructuredDataFactory extends SearchStructuredDataFactor
             validFrom: undefined
         };
     }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     getPaywallData() {
-        const currentIndex = this.cardIndex++;
-        if (currentIndex < 2) {
-            return undefined;
-        }
         return {
             isAccessibleForFree: false,
             cssSelector: '.Paywalled',

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

@@ -6,7 +6,8 @@ import { FAQItemDto } from './dto/FAQItemDto';
 import { BreadcrumbDTO } from './dto/BreadcrumbDTO';
 import { PaywallDTO } from './dto/PaywallDTO';
 export declare abstract class SearchStructuredDataFactory<TCard> {
-    buildStructuredData(title: string, description: string, cards: TCard[], faqItems?: FAQItemDto[], breadcrumbs?: BreadcrumbDTO[]): Promise<WithContext<SearchResultsPage>>;
+    buildStructuredData(title: string, description: string, cards: TCard[], faqItems?: FAQItemDto[], breadcrumbs?: BreadcrumbDTO[], listItemStructure?: boolean): Promise<WithContext<SearchResultsPage>>;
+    private generateMainEntities;
     protected abstract buildStructuredDataForCard(entity: EntityDTO<TCard>): Promise<Thing | undefined> | Thing | undefined;
     /**
      * Get the rating for a card.

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

@@ -1,5 +1,5 @@
 export class SearchStructuredDataFactory {
-    async buildStructuredData(title, description, cards, faqItems = [], breadcrumbs = []) {
+    async buildStructuredData(title, description, cards, faqItems = [], breadcrumbs = [], listItemStructure) {
         const entities = [];
         const ratings = [];
         const offersData = [];
@@ -12,13 +12,7 @@ export class SearchStructuredDataFactory {
                 offersData.push(offer);
             entities.push({ card, offer, reviewRating });
         }
-        const mainEntities = [];
-        for (const entity of entities) {
-            const structuredData = await this.buildStructuredDataForCard(entity);
-            if (!structuredData)
-                continue;
-            mainEntities.push(structuredData);
-        }
+        const mainEntities = await this.generateMainEntities(entities, listItemStructure);
         const data = {
             '@context': 'https://schema.org',
             '@type': 'SearchResultsPage',
@@ -35,6 +29,28 @@ export class SearchStructuredDataFactory {
         }
         return data;
     }
+    async generateMainEntities(entities, listItemStructure) {
+        const mainEntities = [];
+        for (const entity of entities) {
+            const structuredData = await this.buildStructuredDataForCard(entity);
+            if (!structuredData)
+                continue;
+            mainEntities.push(structuredData);
+        }
+        if (listItemStructure) {
+            const listItems = mainEntities.map((entity, index) => ({
+                '@type': 'ListItem',
+                'position': index + 1,
+                'item': entity
+            }));
+            return [{
+                    '@type': 'ItemList',
+                    'numberOfItems': mainEntities.length,
+                    'itemListElement': listItems
+                }];
+        }
+        return mainEntities;
+    }
     /**
      * Get the rating for a card.
      * This method should be overridden by subclasses to provide the specific rating logic.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@studyportals/fawkes",
-	"version": "8.1.3-2",
+	"version": "8.1.3-4",
 	"description": "A package to centralize SEO related logic for SBLP and Sitemap Generator.",
 	"files": [
 		"./dist"
@@ -17,7 +17,7 @@
 		"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": "",
 		"test:dev": "vitest --coverage tests/programmes",
 		"lint": "eslint . --ext .ts",
 		"lint:fix": "eslint . --ext .ts --fix",