@studyportals/fawkes 7.4.2-3 → 8.0.1-0

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

@@ -1,144 +0,0 @@
-export class SearchStructuredDataFactory {
-    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);
-            if (reviewRating)
-                ratings.push(reviewRating);
-            if (offer)
-                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,
-            description,
-            'mainEntity': mainEntities
-        };
-        data.offers = this.constructOptionalPageOffers(offersData);
-        data.hasPart = this.constructOptionalFaqPage(faqItems);
-        data.breadcrumb = this.constructOptionalBreadcrumbs(breadcrumbs);
-        return data;
-    }
-    /**
-     * Get the rating for a card.
-     * This method should be overridden by subclasses to provide the specific rating logic.
-     * If no rating is available, return undefined and no aggregate rating will be constructed for the card & page.
-     *
-     * @param card
-     * @protected
-     */
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    getRating(card) {
-        return undefined;
-    }
-    /**
-     * Get the offer data for a card.
-     * This method should be overridden by subclasses to provide the specific offer logic.
-     * If no offer is available, return undefined and no aggregate offer will be constructed for the card & page.
-     *
-     * @param card
-     * @protected
-     */
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    async getOfferData(card) {
-        return undefined;
-    }
-    constructOptionalPageOffers(offersData) {
-        if (offersData.length <= 0)
-            return;
-        let minPrice = -1;
-        let maxPrice = 0;
-        let totalPrice = 0;
-        for (const offer of offersData) {
-            if (offer.price < minPrice || minPrice === -1) {
-                minPrice = offer.price;
-            }
-            if (offer.price > maxPrice) {
-                maxPrice = offer.price;
-            }
-            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'
-            }
-        };
-    }
-    constructOptionalFaqPage(faqItems) {
-        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)
-                }
-            }))
-        };
-    }
-    constructOptionalBreadcrumbs(breadcrumbs) {
-        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
-            }))
-        };
-    }
-    constructAggregateRating(reviewRating) {
-        if (!reviewRating)
-            return;
-        return {
-            '@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'
-        };
-    }
-    stripHtmlWithListRetain(html) {
-        const tempDiv = document.createElement('div');
-        tempDiv.innerHTML = html;
-        // Replace all <li> elements with bullet points manually
-        tempDiv.querySelectorAll('li').forEach(li => {
-            li.textContent = '• ' + li.textContent;
-        });
-        // Get the text content, which includes newlines for block elements
-        return tempDiv.textContent?.trim() ?? '';
-    }
-}

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

@@ -1,5 +0,0 @@
-export interface BreadcrumbDTO {
-    name: string;
-    position: number;
-    url: string;
-}

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

@@ -1 +0,0 @@
-export {};

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

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

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

@@ -1 +0,0 @@
-export {};

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

@@ -1,4 +0,0 @@
-export interface FAQItemDto {
-    question: string;
-    answer: string;
-}

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

@@ -1 +0,0 @@
-export {};

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

@@ -1,5 +0,0 @@
-export interface OfferDTO {
-    price: number;
-    validFrom: Date | undefined;
-    category: 'tuition';
-}

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

@@ -1 +0,0 @@
-export {};

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

@@ -1,4 +0,0 @@
-export interface ReviewRatingDTO {
-    rating: number;
-    quantity: number;
-}

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

@@ -1 +0,0 @@
-export {};

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

@@ -1,5 +0,0 @@
-export * from './BreadcrumbDTO';
-export * from './EntityDTO';
-export * from './FAQItemDto';
-export * from './OfferDTO';
-export * from './ReviewRatingDTO';

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

@@ -1,5 +0,0 @@
-export * from './BreadcrumbDTO';
-export * from './EntityDTO';
-export * from './FAQItemDto';
-export * from './OfferDTO';
-export * from './ReviewRatingDTO';

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

@@ -1,2 +0,0 @@
-export * from './ProgrammeStructuredDataFactory';
-export * from './dto';

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

@@ -1,2 +0,0 @@
-export * from './ProgrammeStructuredDataFactory';
-export * from './dto';

package/dist/src/structured-data/interface/StructuredDataCurrencyConversionService.d.ts

@@ -1,3 +0,0 @@
-export interface StructuredDataCurrencyConversionService {
-    convert(originalAmount: number, originalCurrency: string, targetCurrency?: string): Promise<number>;
-}

package/dist/src/structured-data/interface/StructuredDataCurrencyConversionService.js

@@ -1 +0,0 @@
-export {};

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

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

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

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