@studyportals/fawkes 8.1.3-0 → 8.2.0

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

@@ -1,25 +1,20 @@
 export class SearchStructuredDataFactory {
-    async buildStructuredData(title, description, cards, faqItems = [], breadcrumbs = [], paywallData) {
+    async buildStructuredData(title, description, cards, faqItems = [], breadcrumbs = []) {
         const entities = [];
         const ratings = [];
         const offersData = [];
         for (const card of cards) {
             const reviewRating = this.getRating(card);
             const offer = await this.getOfferData(card);
-            const paywall = this.getPaywallData(card);
             if (reviewRating)
                 ratings.push(reviewRating);
             if (offer)
                 offersData.push(offer);
-            entities.push({ card, offer, reviewRating, paywall });
-        }
-        const mainEntities = [];
-        for (const entity of entities) {
-            const structuredData = await this.buildStructuredDataForCard(entity);
-            if (!structuredData)
-                continue;
-            mainEntities.push(structuredData);
+            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',
@@ -28,11 +23,8 @@ export class SearchStructuredDataFactory {
             'mainEntity': mainEntities
         };
         data.offers = this.constructOptionalPageOffers(offersData);
-        data.hasPart = this.constructOptionalPageParts(faqItems, paywallData);
+        data.hasPart = this.constructOptionalFaqPage(faqItems);
         data.breadcrumb = this.constructOptionalBreadcrumbs(breadcrumbs);
-        if (paywallData) {
-            data.isAccessibleForFree = paywallData.isAccessibleForFree;
-        }
         return data;
     }
     /**
@@ -56,19 +48,7 @@ export class SearchStructuredDataFactory {
      * @protected
      */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    getOfferData(card) {
-        return Promise.resolve(undefined);
-    }
-    /**
-     * Get the paywall data for a card.
-     * This method should be overridden by subclasses to provide the specific paywall logic.
-     * If no paywall data is available, return undefined and no paywall information will be added to the card.
-     *
-     * @param card
-     * @protected
-     */
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    getPaywallData(card) {
+    async getOfferData(card) {
         return undefined;
     }
     constructOptionalPageOffers(offersData) {
@@ -114,21 +94,6 @@ export class SearchStructuredDataFactory {
             }))
         };
     }
-    constructOptionalPageParts(faqItems, paywallData) {
-        const parts = [];
-        const faqPage = this.constructOptionalFaqPage(faqItems);
-        if (faqPage) {
-            parts.push(faqPage);
-        }
-        if (paywallData && paywallData.cssSelector) {
-            parts.push(this.constructPaywallElement(paywallData));
-        }
-        if (parts.length === 0)
-            return undefined;
-        if (parts.length === 1 && parts[0]['@type'] === 'FAQPage')
-            return parts[0];
-        return parts;
-    }
     constructOptionalBreadcrumbs(breadcrumbs) {
         if (breadcrumbs.length <= 0)
             return;
@@ -143,16 +108,6 @@ export class SearchStructuredDataFactory {
             }))
         };
     }
-    constructPaywallElement(paywallData) {
-        const element = {
-            '@type': 'WebPageElement',
-            'isAccessibleForFree': paywallData.isAccessibleForFree
-        };
-        if (paywallData.cssSelector) {
-            element.cssSelector = paywallData.cssSelector;
-        }
-        return element;
-    }
     constructAggregateRating(reviewRating) {
         if (!reviewRating)
             return;
@@ -176,18 +131,6 @@ export class SearchStructuredDataFactory {
             'category': 'tuition'
         };
     }
-    /**
-     * Add paywall information to any structured data object
-     *
-     * @param structuredData The structured data object to enhance
-     * @param paywallData The paywall data to add
-     * @protected
-     */
-    addPaywallToStructuredData(structuredData, paywallData) {
-        if (!paywallData)
-            return;
-        structuredData.isAccessibleForFree = paywallData.isAccessibleForFree;
-    }
     stripHtmlWithListRetain(html) {
         const tempDiv = document.createElement('div');
         tempDiv.innerHTML = html;

package/dist/src/structured-data/dto/EntityDTO.d.ts

@@ -1,9 +1,7 @@
 import { OfferDTO } from "./OfferDTO";
 import { ReviewRatingDTO } from "./ReviewRatingDTO";
-import { PaywallDTO } from "./PaywallDTO";
 export interface EntityDTO<TCard> {
     card: TCard;
     offer?: OfferDTO;
     reviewRating?: ReviewRatingDTO;
-    paywall?: PaywallDTO;
 }

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

@@ -2,6 +2,5 @@ export * from './BreadcrumbDTO';
 export * from './EntityDTO';
 export * from './FAQItemDto';
 export * from './OfferDTO';
-export * from './PaywallDTO';
 export * from './ReviewRatingDTO';
 export * from './OrganisationDTO';

package/dist/src/structured-data/dto/index.js

@@ -2,6 +2,5 @@ export * from './BreadcrumbDTO';
 export * from './EntityDTO';
 export * from './FAQItemDto';
 export * from './OfferDTO';
-export * from './PaywallDTO';
 export * from './ReviewRatingDTO';
 export * from './OrganisationDTO';

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

@@ -1,4 +1,3 @@
 export * from './ProgrammeStructuredDataFactory';
 export * from './OrganisationStructuredDataFactory';
-export * from './ScholarshipStructuredDataFactory';
 export * from './dto';

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

@@ -1,4 +1,3 @@
 export * from './ProgrammeStructuredDataFactory';
 export * from './OrganisationStructuredDataFactory';
-export * from './ScholarshipStructuredDataFactory';
 export * from './dto';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@studyportals/fawkes",
-	"version": "8.1.3-0",
+	"version": "8.2.0",
 	"description": "A package to centralize SEO related logic for SBLP and Sitemap Generator.",
 	"files": [
 		"./dist"
@@ -82,17 +82,17 @@
 		"husky": "^8.0.3",
 		"jsdom": "^26.0.0",
 		"prettier": "^3.5.3",
+		"schema-dts": "^1.1.5",
+		"ts-loader": "^9.5.2",
 		"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"
+		"vitest": "^2.1.8"
 	},
 	"dependencies": {
-		"@studyportals/domain-client": "^6.3.0",
+		"@studyportals/domain-client": "7.1.0",
 		"@studyportals/ranking-api-interface": "^1.3.12",
-		"@studyportals/search-filters": "^6.1.0",
+		"@studyportals/search-filters": "^6.3.1",
 		"@studyportals/static-domain-data": "^6.1.0"
 	},
 	"optionalDependencies": {

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

@@ -1,14 +0,0 @@
-import { MonetaryGrant } from "schema-dts";
-import { StructuredDataCurrencyConversionService } from "./interface/StructuredDataCurrencyConversionService";
-import { SearchStructuredDataFactory } from "./SearchStructuredDataFactory";
-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>;
-    protected getPaywallData(card: IScholarshipCard): PaywallDTO | undefined;
-    private buildAmount;
-}

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

@@ -1,69 +0,0 @@
-import { SearchStructuredDataFactory } from "./SearchStructuredDataFactory";
-export class ScholarshipStructuredDataFactory extends SearchStructuredDataFactory {
-    currencyConversionService;
-    cardIndex = 0;
-    constructor(currencyConversionService) {
-        super();
-        this.currencyConversionService = currencyConversionService;
-    }
-    async buildStructuredDataForCard(entity) {
-        const url = `https://${window.location.host}/scholarships/${entity.card.getProviderId()}/${entity.card.getScholarshipVirtualName()}`;
-        const amount = await this.buildAmount(entity.card);
-        const structuredData = {
-            "@type": "MonetaryGrant",
-            name: entity.card.getScholarshipTitle() || undefined,
-            description: entity.card.getDescriptionOfApplicationBasis() || undefined,
-            funder: entity.card.getProviderName() || undefined,
-            url,
-            amount
-        };
-        this.addPaywallToStructuredData(structuredData, entity.paywall);
-        return structuredData;
-    }
-    async getOfferData(card) {
-        const benefits = card.getDescriptionOfBenefits();
-        const hasMonetaryValue = benefits && !isNaN(Number(benefits.split(' ')[0]));
-        if (!hasMonetaryValue)
-            return;
-        const [amount, currency] = [Number(benefits.split(' ')[0]), benefits.split(' ')[1]];
-        return {
-            price: Math.round(await this.currencyConversionService.convert(amount, currency, 'USD')),
-            category: 'tuition',
-            validFrom: undefined
-        };
-    }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    getPaywallData(card) {
-        const currentIndex = this.cardIndex++;
-        if (currentIndex < 2) {
-            return undefined;
-        }
-        return {
-            isAccessibleForFree: false,
-            cssSelector: '.scholarship-paywall',
-            accessMode: 'registration'
-        };
-    }
-    async buildAmount(card) {
-        const benefits = card.getDescriptionOfBenefits();
-        const hasMonetaryValue = benefits && !isNaN(Number(benefits.split(' ')[0]));
-        let amount;
-        let currency;
-        if (hasMonetaryValue) {
-            [amount, currency] = [Number(benefits.split(' ')[0]), benefits.split(' ')[1]];
-        }
-        let value;
-        if (hasMonetaryValue) {
-            value = Math.round(await this.currencyConversionService.convert(amount, currency, 'USD'));
-            currency = 'USD';
-        }
-        else {
-            value = benefits || undefined;
-        }
-        return {
-            "@type": "MonetaryAmount",
-            value,
-            currency
-        };
-    }
-}

package/dist/src/structured-data/dto/PaywallDTO.d.ts

@@ -1,14 +0,0 @@
-export interface PaywallDTO {
-    /**
-     * Whether the content is behind a paywall
-     */
-    isAccessibleForFree: boolean;
-    /**
-     * CSS selector for the paywall element (optional)
-     */
-    cssSelector?: string;
-    /**
-     * Type of access restriction
-     */
-    accessMode?: 'subscription' | 'payment' | 'registration' | 'free';
-}