@studyportals/fawkes 4.0.2-1 → 4.0.2-11

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

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

package/dist/src/common/IPresenter.js

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

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

@@ -2,3 +2,4 @@ export * from './ISeoInfoBase';
 export * from './ISeoFilterState';
 export * from './ISearchApplicationState';
 export * from './ISearchIndexabilityManager';
+export * from './IPresenter';

package/dist/src/common/index.js

@@ -2,3 +2,4 @@ export * from './ISeoInfoBase';
 export * from './ISeoFilterState';
 export * from './ISearchApplicationState';
 export * from './ISearchIndexabilityManager';
+export * from './IPresenter';

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

@@ -13,5 +13,16 @@ export declare enum FilterCombinations {
     CONTINENT_ATTENDANCE = "continentAttendance",
     COUNTRY_ATTENDANCE = "countryAttendance",
     ATTENDANCE = "attendance",
-    CONTINENT = "continent"
+    CONTINENT = "continent",
+    RANKED_AREA = "rankedArea",
+    RANKED_AREA_DISCIPLINE = "rankedAreaDiscipline",
+    RANKED_ATTENDANCE = "rankedAttendance",
+    RANKED_ATTENDANCE_DISCIPLINE = "rankedAttendancedDiscipline",
+    RANKED_CONTINENT = "rankedContinent",
+    RANKED_CONTINENT_ATTENDANCE = "rankedContinentAttendance",
+    RANKED_COUNTRY = "rankedCountry",
+    RANKED_COUNTRY_ATTENDANCE = "rankedCountryAttendance",
+    RANKED_DISCIPLINE_COUNTRY = "rankedDisciplineCountry",
+    RANKED_DISCIPLINE = "rankedDiscipline",
+    RANKED_UNFILTERED = "rankedUnfiltered"
 }

package/dist/src/enums/FilterCombinations.js

@@ -15,4 +15,15 @@ export var FilterCombinations;
     FilterCombinations["COUNTRY_ATTENDANCE"] = "countryAttendance";
     FilterCombinations["ATTENDANCE"] = "attendance";
     FilterCombinations["CONTINENT"] = "continent";
+    FilterCombinations["RANKED_AREA"] = "rankedArea";
+    FilterCombinations["RANKED_AREA_DISCIPLINE"] = "rankedAreaDiscipline";
+    FilterCombinations["RANKED_ATTENDANCE"] = "rankedAttendance";
+    FilterCombinations["RANKED_ATTENDANCE_DISCIPLINE"] = "rankedAttendancedDiscipline";
+    FilterCombinations["RANKED_CONTINENT"] = "rankedContinent";
+    FilterCombinations["RANKED_CONTINENT_ATTENDANCE"] = "rankedContinentAttendance";
+    FilterCombinations["RANKED_COUNTRY"] = "rankedCountry";
+    FilterCombinations["RANKED_COUNTRY_ATTENDANCE"] = "rankedCountryAttendance";
+    FilterCombinations["RANKED_DISCIPLINE_COUNTRY"] = "rankedDisciplineCountry";
+    FilterCombinations["RANKED_DISCIPLINE"] = "rankedDiscipline";
+    FilterCombinations["RANKED_UNFILTERED"] = "rankedUnfiltered";
 })(FilterCombinations || (FilterCombinations = {}));

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

@@ -1,8 +1,6 @@
-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;
 }

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

@@ -1,9 +1,7 @@
-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/ranked/RankedArea.js

@@ -30,6 +30,6 @@ export class RankedArea extends RankedOrganisationsSeoIndexabilityPolicy {
         return paths;
     }
     get filterCombination() {
-        return FilterCombinations.AREA;
+        return FilterCombinations.RANKED_AREA;
     }
 }

package/dist/src/organisations/policies/ranked/RankedAreaDiscipline.js

@@ -19,7 +19,7 @@ export class RankedAreaDiscipline extends RankedOrganisationsSeoIndexabilityPoli
         this.addRankedResultsCountRule();
     }
     get filterCombination() {
-        return FilterCombinations.AREA_DISCIPLINE;
+        return FilterCombinations.RANKED_AREA_DISCIPLINE;
     }
     async generateUrls() {
         const areaFragments = AreaPresenter.getInstance().getFragments();

package/dist/src/organisations/policies/ranked/RankedAttendance.js

@@ -28,6 +28,6 @@ export class RankedAttendance extends RankedOrganisationsSeoIndexabilityPolicy {
         return paths;
     }
     get filterCombination() {
-        return FilterCombinations.ATTENDANCE;
+        return FilterCombinations.RANKED_ATTENDANCE;
     }
 }

package/dist/src/organisations/policies/ranked/RankedAttendanceDiscipline.js

@@ -18,7 +18,7 @@ export class RankedAttendanceDiscipline extends RankedOrganisationsSeoIndexabili
         this.addRankedResultsCountRule();
     }
     get filterCombination() {
-        return FilterCombinations.ATTENDANCE_DISCIPLINE;
+        return FilterCombinations.RANKED_ATTENDANCE_DISCIPLINE;
     }
     async generateUrls() {
         const attendanceFragments = AttendancePresenter.getInstance().getFragments();

package/dist/src/organisations/policies/ranked/RankedContinent.js

@@ -26,6 +26,6 @@ export class RankedContinent extends RankedOrganisationsSeoIndexabilityPolicy {
         return paths;
     }
     get filterCombination() {
-        return FilterCombinations.CONTINENT;
+        return FilterCombinations.RANKED_CONTINENT;
     }
 }

package/dist/src/organisations/policies/ranked/RankedContinentAttendance.js

@@ -38,6 +38,6 @@ export class RankedContinentAttendance extends RankedOrganisationsSeoIndexabilit
         return paths;
     }
     get filterCombination() {
-        return FilterCombinations.CONTINENT_ATTENDANCE;
+        return FilterCombinations.RANKED_CONTINENT_ATTENDANCE;
     }
 }

package/dist/src/organisations/policies/ranked/RankedCountry.js

@@ -23,6 +23,6 @@ export class RankedCountry extends RankedOrganisationsSeoIndexabilityPolicy {
         return paths;
     }
     get filterCombination() {
-        return FilterCombinations.COUNTRY;
+        return FilterCombinations.RANKED_COUNTRY;
     }
 }

package/dist/src/organisations/policies/ranked/RankedCountryAttendance.js

@@ -36,6 +36,6 @@ export class RankedCountryAttendance extends RankedOrganisationsSeoIndexabilityP
         return paths;
     }
     get filterCombination() {
-        return FilterCombinations.COUNTRY_ATTENDANCE;
+        return FilterCombinations.RANKED_COUNTRY_ATTENDANCE;
     }
 }

package/dist/src/organisations/policies/ranked/RankedCountryDiscipline.js

@@ -34,6 +34,6 @@ export class RankedCountryDiscipline extends RankedOrganisationsSeoIndexabilityP
         return paths;
     }
     get filterCombination() {
-        return FilterCombinations.DISCIPLINE_COUNTRY;
+        return FilterCombinations.RANKED_DISCIPLINE_COUNTRY;
     }
 }

package/dist/src/organisations/policies/ranked/RankedDiscipline.js

@@ -26,6 +26,6 @@ export class RankedDiscipline extends RankedOrganisationsSeoIndexabilityPolicy {
         return paths;
     }
     get filterCombination() {
-        return FilterCombinations.DISCIPLINE;
+        return FilterCombinations.RANKED_DISCIPLINE;
     }
 }

package/dist/src/organisations/policies/ranked/RankedUnfiltered.js

@@ -15,6 +15,6 @@ export class RankedUnfiltered extends RankedOrganisationsSeoIndexabilityPolicy {
         return [];
     }
     get filterCombination() {
-        return FilterCombinations.UNFILTERED;
+        return FilterCombinations.RANKED_UNFILTERED;
     }
 }

package/dist/src/presenters/AreaPresenter.d.ts

@@ -1,5 +1,8 @@
 import { IAreaFragment } from './fragments/IAreaFragment';
-export declare class AreaPresenter {
+import { IPresenter } from '../common';
+import { FilterKey } from '@studyportals/search-filters';
+export declare class AreaPresenter implements IPresenter {
+    readonly filterKey: FilterKey;
     private static instance;
     private readonly fragments;
     private constructor();

package/dist/src/presenters/AreaPresenter.js

@@ -1,6 +1,8 @@
 import { areasAll } from '@studyportals/static-domain-data/areas/areas';
 import { areaGetPath } from '@studyportals/static-domain-data/areas/area-get-path';
+import { FilterKey } from '@studyportals/search-filters';
 export class AreaPresenter {
+    filterKey = FilterKey.AREA;
     static instance;
     fragments;
     constructor() {

package/dist/src/presenters/AttendancePresenter.d.ts

@@ -1,5 +1,8 @@
+import { IPresenter } from '../common';
 import { IFragment } from './fragments/IFragment';
-export declare class AttendancePresenter {
+import { FilterKey } from '@studyportals/search-filters';
+export declare class AttendancePresenter implements IPresenter {
+    readonly filterKey: FilterKey;
     private static instance;
     private readonly fragments;
     private constructor();

package/dist/src/presenters/AttendancePresenter.js

@@ -1,4 +1,6 @@
+import { FilterKey } from '@studyportals/search-filters';
 export class AttendancePresenter {
+    filterKey = FilterKey.DELIVERY_METHOD;
     static instance;
     fragments;
     constructor() {

package/dist/src/presenters/ContinentPresenter.d.ts

@@ -1,5 +1,8 @@
 import { IFragment } from './fragments/IFragment';
-export declare class ContinentPresenter {
+import { IPresenter } from '../common';
+import { FilterKey } from '@studyportals/search-filters';
+export declare class ContinentPresenter implements IPresenter {
+    readonly filterKey: FilterKey;
     private static instance;
     private readonly fragments;
     private constructor();

package/dist/src/presenters/ContinentPresenter.js

@@ -1,6 +1,8 @@
 import { continentsAll } from '@studyportals/static-domain-data/continents/continents';
 import { continentGetPath } from '@studyportals/static-domain-data/continents/continent-get-path';
+import { FilterKey } from '@studyportals/search-filters';
 export class ContinentPresenter {
+    filterKey = FilterKey.CONTINENT;
     static instance;
     fragments;
     constructor() {

package/dist/src/presenters/CountryPresenter.d.ts

@@ -1,5 +1,8 @@
 import { ICountryFragment } from './fragments/ICountryFragment';
-export declare class CountryPresenter {
+import { IPresenter } from '../common';
+import { FilterKey } from '@studyportals/search-filters';
+export declare class CountryPresenter implements IPresenter {
+    readonly filterKey: FilterKey;
     private static instance;
     private readonly fragments;
     private constructor();

package/dist/src/presenters/CountryPresenter.js

@@ -1,6 +1,8 @@
 import { countriesExtendedAll } from '@studyportals/static-domain-data/countries/countries-extended';
 import { countryGetIsoCodePath } from '@studyportals/static-domain-data/countries/country-get-iso-path';
+import { FilterKey } from '@studyportals/search-filters';
 export class CountryPresenter {
+    filterKey = FilterKey.COUNTRY;
     static instance;
     fragments;
     constructor() {

package/dist/src/presenters/DisciplinePresenter.d.ts

@@ -1,5 +1,8 @@
 import { IFragment } from './fragments/IFragment';
-export declare class DisciplinePresenter {
+import { IPresenter } from '../common';
+import { FilterKey } from '@studyportals/search-filters';
+export declare class DisciplinePresenter implements IPresenter {
+    readonly filterKey: FilterKey;
     private static instance;
     private readonly fragments;
     private constructor();

package/dist/src/presenters/DisciplinePresenter.js

@@ -1,7 +1,9 @@
 import { disciplinesAll } from '@studyportals/static-domain-data/disciplines/disciplines';
 import { subdisciplinesAll } from '@studyportals/static-domain-data/disciplines/subdisciplines';
 import { disciplineGetVirtualPath } from '@studyportals/static-domain-data/disciplines/discipline-get-virtual-path';
+import { FilterKey } from '@studyportals/search-filters';
 export class DisciplinePresenter {
+    filterKey = FilterKey.DISCIPLINES;
     static instance;
     fragments;
     constructor() {

package/dist/src/sitemap-generator/BaseSitemapUrlGeneratorManager.d.ts

@@ -1,7 +1,13 @@
 import { ISitemapUrlGenerator } from '../common/ISitemapUrlGenerator';
 import { ISitemapUrlGeneratorManager } from './ISitemapUrlGeneratorManager';
 import { FilterCombinations } from '../enums/FilterCombinations';
+import { IPresenter } from '../common';
+import { FilterKey } from '@studyportals/search-filters';
 export declare abstract class BaseSitemapUrlGeneratorManager implements ISitemapUrlGeneratorManager {
     abstract readonly policies: ISitemapUrlGenerator[];
+    protected abstract readonly presenters: IPresenter[];
+    protected readonly filterKeyValueCounts: Map<FilterKey, number>;
     generateUrls(): Promise<Map<FilterCombinations, string[]>>;
+    getFilterKeyValueCounts(): Map<FilterKey, number>;
+    protected setFilterKeyValueCounts(): void;
 }

package/dist/src/sitemap-generator/BaseSitemapUrlGeneratorManager.js

@@ -1,11 +1,32 @@
 export class BaseSitemapUrlGeneratorManager {
+    filterKeyValueCounts = new Map();
     async generateUrls() {
         const map = new Map();
-        await Promise.all(this.policies.map(async (policy) => {
+        for (const policy of this.policies) {
+            console.debug(`Generating sitemap urls for policy: ${policy.filterCombination}`); // eslint-disable-line no-console
             const filterCombination = policy.filterCombination;
             const urls = await policy.generateSitemapUrls();
+            console.debug(`Generated ${urls.length} urls for policy: ${filterCombination}`); // eslint-disable-line no-console
             map.set(filterCombination, urls);
-        }));
+        }
+        // await Promise.all(
+        // 	this.policies.map(async (policy) => {
+        // 		console.debug(`Generating sitemap urls for policy: ${policy.filterCombination}`); // eslint-disable-line no-console
+        // 		const filterCombination = policy.filterCombination;
+        // 		const urls = await policy.generateSitemapUrls();
+        // 		console.debug(`Generated ${urls.length} urls for policy: ${filterCombination}`); // eslint-disable-line no-console
+        // 		map.set(filterCombination, urls);
+        // 	})
+        // );
         return map;
     }
+    getFilterKeyValueCounts() {
+        return this.filterKeyValueCounts;
+    }
+    setFilterKeyValueCounts() {
+        for (const presenter of this.presenters) {
+            const count = presenter.getFragments().length;
+            this.filterKeyValueCounts.set(presenter.filterKey, count);
+        }
+    }
 }

package/dist/src/sitemap-generator/ISitemapUrlGeneratorManager.d.ts

@@ -1,4 +1,6 @@
 import { FilterCombinations } from '../enums/FilterCombinations';
+import { FilterKey } from '@studyportals/search-filters';
 export interface ISitemapUrlGeneratorManager {
     generateUrls(): Promise<Map<FilterCombinations, string[]>>;
+    getFilterKeyValueCounts(): Map<FilterKey, number>;
 }

package/dist/src/sitemap-generator/OrganisationsSitemapUrlGeneratorManager.d.ts

@@ -4,8 +4,14 @@ import { ISearchApiClient } from '../sitemap-generator/ISearchApiClient';
 import { BaseSitemapUrlGeneratorManager } from './BaseSitemapUrlGeneratorManager';
 import { PortalType } from '@studyportals/domain-client';
 import { IRankingApiClient } from './IRankingApiClient';
+import { AreaPresenter } from '../presenters/AreaPresenter';
+import { AttendancePresenter } from '../presenters/AttendancePresenter';
+import { ContinentPresenter } from '../presenters/ContinentPresenter';
+import { CountryPresenter } from '../presenters/CountryPresenter';
+import { DisciplinePresenter } from '../presenters/DisciplinePresenter';
 export declare class OrganisationsSitemapUrlGeneratorManager extends BaseSitemapUrlGeneratorManager {
     readonly portalType: PortalType;
     readonly policies: ISitemapUrlGenerator[];
+    protected readonly presenters: (AreaPresenter | AttendancePresenter | ContinentPresenter | CountryPresenter | DisciplinePresenter)[];
     constructor(portalType: PortalType, searchApiClient: ISearchApiClient, organisationsClient: IOrganisationsClient, rankingApiClient: IRankingApiClient);
 }

package/dist/src/sitemap-generator/OrganisationsSitemapUrlGeneratorManager.js

@@ -1,9 +1,22 @@
 import { DependencyTypes } from '../enums/DependencyTypes';
 import { BaseSitemapUrlGeneratorManager } from './BaseSitemapUrlGeneratorManager';
-import { Area, AreaAttendance, Attendance, Continent, Country, CountryAttendance, RankedArea, RankedAreaDiscipline, RankedAttendance, RankedAttendanceDiscipline, RankedContinent, RankedContinentAttendance, RankedCountry, RankedCountryAttendance, RankedCountryDiscipline, RankedDiscipline, RankedUnfiltered, Unfiltered } from '../organisations/policies';
+// import { Area, AreaAttendance, Attendance, Continent, Country, CountryAttendance, RankedArea, RankedAreaDiscipline, RankedAttendance, RankedAttendanceDiscipline, RankedContinent, RankedContinentAttendance, RankedCountry, RankedCountryAttendance, RankedCountryDiscipline, RankedDiscipline, RankedUnfiltered, Unfiltered } from '../organisations/policies';
+import { Area, AreaAttendance, Attendance, Continent, Country, CountryAttendance, RankedArea, Unfiltered } from '../organisations/policies';
+import { AreaPresenter } from '../presenters/AreaPresenter';
+import { AttendancePresenter } from '../presenters/AttendancePresenter';
+import { ContinentPresenter } from '../presenters/ContinentPresenter';
+import { CountryPresenter } from '../presenters/CountryPresenter';
+import { DisciplinePresenter } from '../presenters/DisciplinePresenter';
 export class OrganisationsSitemapUrlGeneratorManager extends BaseSitemapUrlGeneratorManager {
     portalType;
     policies;
+    presenters = [
+        AreaPresenter.getInstance(),
+        AttendancePresenter.getInstance(),
+        ContinentPresenter.getInstance(),
+        CountryPresenter.getInstance(),
+        DisciplinePresenter.getInstance()
+    ];
     constructor(portalType, searchApiClient, organisationsClient, rankingApiClient) {
         super();
         this.portalType = portalType;
@@ -23,16 +36,17 @@ export class OrganisationsSitemapUrlGeneratorManager extends BaseSitemapUrlGener
             new CountryAttendance(dependencies),
             new Unfiltered(dependencies),
             new RankedArea(dependencies),
-            new RankedAreaDiscipline(dependencies),
-            new RankedAttendance(dependencies),
-            new RankedAttendanceDiscipline(dependencies),
-            new RankedContinent(dependencies),
-            new RankedContinentAttendance(dependencies),
-            new RankedCountry(dependencies),
-            new RankedCountryAttendance(dependencies),
-            new RankedCountryDiscipline(dependencies),
-            new RankedDiscipline(dependencies),
-            new RankedUnfiltered(dependencies)
+            // new RankedAreaDiscipline(dependencies),
+            // new RankedAttendance(dependencies),
+            // new RankedAttendanceDiscipline(dependencies),
+            // new RankedContinent(dependencies),
+            // new RankedContinentAttendance(dependencies),
+            // new RankedCountry(dependencies),
+            // new RankedCountryAttendance(dependencies),
+            // new RankedCountryDiscipline(dependencies),
+            // new RankedDiscipline(dependencies),
+            // new RankedUnfiltered(dependencies)
         ];
+        this.setFilterKeyValueCounts();
     }
 }

package/dist/src/sitemap-generator/ScholarshipsSitemapUrlGeneratorManager.d.ts

@@ -4,5 +4,6 @@ import { ISearchApiClient } from '../sitemap-generator/ISearchApiClient';
 import { BaseSitemapUrlGeneratorManager } from './BaseSitemapUrlGeneratorManager';
 export declare class ScholarshipsSitemapUrlGeneratorManager extends BaseSitemapUrlGeneratorManager {
     readonly policies: ISitemapUrlGenerator[];
+    protected readonly presenters: never[];
     constructor(searchApiClient: ISearchApiClient, organisationsClient: IOrganisationsClient);
 }

package/dist/src/sitemap-generator/ScholarshipsSitemapUrlGeneratorManager.js

@@ -8,6 +8,7 @@ import { Unfiltered } from '../scholarships/policies/Unfiltered';
 import { BaseSitemapUrlGeneratorManager } from './BaseSitemapUrlGeneratorManager';
 export class ScholarshipsSitemapUrlGeneratorManager extends BaseSitemapUrlGeneratorManager {
     policies;
+    presenters = [];
     constructor(searchApiClient, organisationsClient) {
         super();
         const dependencies = {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@studyportals/fawkes",
-	"version": "4.0.2-1",
+	"version": "4.0.2-11",
 	"description": "A package to centralize SEO related logic for SBLP and Sitemap Generator.",
 	"files": [
 		"./dist"