@studyportals/fawkes 6.0.1-2 → 6.0.1-20

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

@@ -0,0 +1,6 @@
+import { IRule } from "./IRule";
+export interface IPolicyMetaData {
+    getAllRules(): IRule[];
+    getName(): string;
+    getDescription(): string;
+}

package/dist/src/common/policies/BaseSeoIndexabilityPolicy.d.ts

@@ -17,7 +17,7 @@ export declare abstract class BaseSeoIndexabilityPolicy<TDependencies extends ID
     generateSitemapUrls(): Promise<string[]>;
     protected isIndexable(): Promise<boolean>;
     protected checkRulesForSearch(dependencies: ISearchDependencies): Promise<boolean>;
-    protected checkRulesForSitemap(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
+    checkRulesForSitemap(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
     protected isIndexabilityPolicyDependencies(): boolean;
     protected isSitemapUrlGeneratorDependencies(): boolean;
     getAllRules(): IRule[];

package/dist/src/organisations/OrganisationsRuleBasedIndexabilityPolicy.d.ts

@@ -0,0 +1,11 @@
+import { PortalType } from '@studyportals/domain-client';
+import { IOrganisationsSeoDependencies } from './types/IOrganisationsSeoDependencies';
+import { SortingOptions } from '../enums/SortingOptions';
+import { BaseSeoIndexabilityPolicy } from '../common/policies/BaseSeoIndexabilityPolicy';
+export declare abstract class OrganisationsRuleBasedIndexabilityPolicy extends BaseSeoIndexabilityPolicy<IOrganisationsSeoDependencies> {
+    protected readonly indexablePortalTypes: PortalType[];
+    protected abstract readonly sortingOption: SortingOptions;
+    constructor(dependencies: IOrganisationsSeoDependencies);
+    protected isIndexable(): Promise<boolean>;
+    private matchesSortingOption;
+}

package/dist/src/organisations/OrganisationsRuleBasedIndexabilityPolicy.js

@@ -0,0 +1,19 @@
+import { PortalType } from '@studyportals/domain-client';
+import { BaseSeoIndexabilityPolicy } from '../common/policies/BaseSeoIndexabilityPolicy';
+export class OrganisationsRuleBasedIndexabilityPolicy extends BaseSeoIndexabilityPolicy {
+    indexablePortalTypes = [PortalType.MASTER];
+    constructor(dependencies) {
+        super(dependencies);
+    }
+    async isIndexable() {
+        const isIndexable = await super.isIndexable();
+        if (!isIndexable) {
+            return false;
+        }
+        return this.indexablePortalTypes.includes(this.dependencies.portalType) && this.matchesSortingOption();
+    }
+    matchesSortingOption() {
+        const dependencies = this.dependencies;
+        return dependencies.sortingState.getSelectedOption() === this.sortingOption;
+    }
+}

package/dist/src/organisations/rules/OnlineAttendanceRule.d.ts

@@ -2,4 +2,5 @@ import { BaseFilterKeyValueRule } from '../../common/rules/BaseFilterKeyValueRul
 export declare class OnlineAttendanceRule extends BaseFilterKeyValueRule {
     constructor();
     getName(): string;
+    getDescription(): string;
 }

package/dist/src/organisations/rules/OnlineAttendanceRule.js

@@ -8,4 +8,7 @@ export class OnlineAttendanceRule extends BaseFilterKeyValueRule {
     getName() {
         return 'OnlineAttendanceRule';
     }
+    getDescription() {
+        return 'Indexable if attendance is online';
+    }
 }

package/dist/src/programmes/IProgrammeSearchApplicationState.d.ts

@@ -0,0 +1,4 @@
+import { ISearchApplicationState } from '../common';
+export interface IProgrammeSearchApplicationState extends ISearchApplicationState {
+    getPageNumber(): number;
+}

package/dist/src/programmes/IProgrammeSearchApplicationState.js

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

package/dist/src/programmes/IProgrammeSearchDependencies.d.ts

@@ -0,0 +1,7 @@
+import { ISearchDependencies } from '../common/ISearchDependencies';
+import { IProgrammeSearchApplicationState } from './IProgrammeSearchApplicationState';
+import { PortalType } from '@studyportals/domain-client';
+export interface IProgrammeSearchDependencies extends ISearchDependencies {
+    portalType: PortalType;
+    applicationState: IProgrammeSearchApplicationState;
+}

package/dist/src/programmes/IProgrammeSearchDependencies.js

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

package/dist/src/programmes/IProgrammesSeoDependencies.d.ts

@@ -0,0 +1,2 @@
+import { IProgrammeSearchDependencies } from "./IProgrammeSearchDependencies";
+export type IProgrammesSeoDependencies = IProgrammeSearchDependencies;

package/dist/src/programmes/IProgrammesSeoDependencies.js

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

package/dist/src/programmes/rules/OnlineAttendanceRule.d.ts

@@ -0,0 +1,5 @@
+import { BaseFilterKeyValueRule } from '../../common/rules/BaseFilterKeyValueRule';
+export declare class OnlineAttendanceRule extends BaseFilterKeyValueRule {
+    constructor();
+    getName(): string;
+}

package/dist/src/programmes/rules/OnlineAttendanceRule.js

@@ -0,0 +1,11 @@
+import { FilterKey } from '@studyportals/search-filters';
+import { BaseFilterKeyValueRule } from '../../common/rules/BaseFilterKeyValueRule';
+export class OnlineAttendanceRule extends BaseFilterKeyValueRule {
+    constructor() {
+        const filterKeyValues = new Map([[FilterKey.DELIVERY_METHOD, ['online']]]);
+        super(filterKeyValues);
+    }
+    getName() {
+        return 'OnlineAttendanceRule';
+    }
+}

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

@@ -1,13 +1,13 @@
-import { ISitemapUrlGenerator } from '../common/ISitemapUrlGenerator';
 import { ISearchApiClient } from '../sitemap-generator/ISearchApiClient';
 import { BaseSitemapUrlGeneratorManager } from './BaseSitemapUrlGeneratorManager';
 import { PortalType } from '@studyportals/domain-client';
 import { IPageNumberProvider } from './IPageNumberProvider';
 import { FilterKey } from '@studyportals/search-filters';
 import { IPresenter } from '../common';
+import { IProgrammeSitemapUrlGenerator } from '../programmes/types/IProgrammeSitemapUrlGenerator';
 export declare class ProgrammesSitemapUrlGeneratorManager extends BaseSitemapUrlGeneratorManager {
     readonly portalType: PortalType;
-    readonly policies: ISitemapUrlGenerator[];
+    readonly policies: IProgrammeSitemapUrlGenerator[];
     readonly presenters: Map<FilterKey, IPresenter>;
     constructor(portalType: PortalType, searchApiClient: ISearchApiClient, pageNumberProvider: IPageNumberProvider);
 }

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

@@ -1,6 +1,36 @@
 import { DependencyTypes } from '../enums/DependencyTypes';
 import { BaseSitemapUrlGeneratorManager } from './BaseSitemapUrlGeneratorManager';
-import { Area, Attendance, AttendanceDegree, Continent, ContinentTuitionFee, Country, CountryAttendance, Discipline, SpecialProgrammes, TuitionFee, Unfiltered, CountryAttendanceDegree, CountryDegree, CountryDuration, CountryDurationDegree, CountryEducationalForm, CountryFormat, CountryTuitionFee, DisciplineArea, DisciplineAttendance, DisciplineContinent, DisciplineCountry, DisciplineCountryDegree, DisciplineCountryEducationalForm, DisciplineDegree, DisciplineDuration, DisciplineEducationalForm, DisciplineFormat, DisciplineTuitionFee, DisciplineTuitionFeeAttendance } from '../programmes/policies';
+import { Area, 
+// Attendance,
+// AttendanceDegree,
+// Continent,
+// ContinentTuitionFee,
+// Country,
+// CountryAttendance,
+Discipline, 
+// SpecialProgrammes,
+// TuitionFee,
+Unfiltered, 
+// CountryAttendanceDegree,
+// CountryDegree,
+// CountryDuration,
+// CountryDurationDegree,
+// CountryEducationalForm,
+// CountryFormat,
+// CountryTuitionFee,
+DisciplineArea,
+// DisciplineAttendance,
+// DisciplineContinent,
+// DisciplineCountry,
+// DisciplineCountryDegree,
+// DisciplineCountryEducationalForm,
+// DisciplineDegree,
+// DisciplineDuration,
+// DisciplineEducationalForm,
+// DisciplineFormat,
+// DisciplineTuitionFee,
+// DisciplineTuitionFeeAttendance
+ } from '../programmes/policies';
 import { FilterKey } from '@studyportals/search-filters';
 import { AreaPresenter } from '../presenters/AreaPresenter';
 import { AttendancePresenter } from '../presenters/AttendancePresenter';
@@ -28,35 +58,35 @@ export class ProgrammesSitemapUrlGeneratorManager extends BaseSitemapUrlGenerato
         };
         this.policies = [
             new Area(dependencies),
-            new Attendance(dependencies),
-            new AttendanceDegree(dependencies),
-            new Continent(dependencies),
-            new ContinentTuitionFee(dependencies),
-            new Country(dependencies),
-            new CountryAttendance(dependencies),
+            // new Attendance(dependencies),
+            // new AttendanceDegree(dependencies),
+            // new Continent(dependencies),
+            // new ContinentTuitionFee(dependencies),
+            // new Country(dependencies),
+            // new CountryAttendance(dependencies),
             new Discipline(dependencies),
-            new SpecialProgrammes(dependencies),
-            new TuitionFee(dependencies),
+            // new SpecialProgrammes(dependencies),
+            // new TuitionFee(dependencies),
             new Unfiltered(dependencies),
-            new CountryAttendanceDegree(dependencies),
-            new CountryDegree(dependencies),
-            new CountryDuration(dependencies),
-            new CountryDurationDegree(dependencies),
-            new CountryEducationalForm(dependencies),
-            new CountryFormat(dependencies),
-            new CountryTuitionFee(dependencies),
+            // new CountryAttendanceDegree(dependencies),
+            // new CountryDegree(dependencies),
+            // new CountryDuration(dependencies),
+            // new CountryDurationDegree(dependencies),
+            // new CountryEducationalForm(dependencies),
+            // new CountryFormat(dependencies),
+            // new CountryTuitionFee(dependencies),
             new DisciplineArea(dependencies),
-            new DisciplineAttendance(dependencies),
-            new DisciplineContinent(dependencies),
-            new DisciplineCountry(dependencies),
-            new DisciplineCountryDegree(dependencies),
-            new DisciplineCountryEducationalForm(dependencies),
-            new DisciplineDegree(dependencies),
-            new DisciplineDuration(dependencies),
-            new DisciplineEducationalForm(dependencies),
-            new DisciplineFormat(dependencies),
-            new DisciplineTuitionFee(dependencies),
-            new DisciplineTuitionFeeAttendance(dependencies)
+            // new DisciplineAttendance(dependencies),
+            // new DisciplineContinent(dependencies),
+            // new DisciplineCountry(dependencies),
+            // new DisciplineCountryDegree(dependencies),
+            // new DisciplineCountryEducationalForm(dependencies),
+            // new DisciplineDegree(dependencies),
+            // new DisciplineDuration(dependencies),
+            // new DisciplineEducationalForm(dependencies),
+            // new DisciplineFormat(dependencies),
+            // new DisciplineTuitionFee(dependencies),
+            // new DisciplineTuitionFeeAttendance(dependencies)
         ];
         this.presenters.set(FilterKey.AREA, AreaPresenter.getInstance());
         this.presenters.set(FilterKey.DELIVERY_METHOD, AttendancePresenter.getInstance());

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@studyportals/fawkes",
-	"version": "6.0.1-2",
+	"version": "6.0.1-20",
 	"description": "A package to centralize SEO related logic for SBLP and Sitemap Generator.",
 	"files": [
 		"./dist"
@@ -16,7 +16,7 @@
 		"publish-beta": "npm run prepare-deployment && npm version prerelease && npm publish --tag beta --access=public",
 		"prepare": "husky install",
 		"test": "vitest run --coverage",
-		"test:dev": "vitest --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 ."

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

@@ -1,3 +0,0 @@
-export interface IRankingApiClient {
-    getFacets(): Promise<string[]>;
-}

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

@@ -1,9 +0,0 @@
-import { ISitemapUrlGeneratorManager } from './ISitemapUrlGeneratorManager';
-import { FilterCombinations } from '../enums/FilterCombinations';
-import { IOrganisationsClient } from '../sitemap-generator/IOrganisationsClient';
-import { ISearchApiClient } from '../sitemap-generator/ISearchApiClient';
-export declare class SitemapUrlGeneratorManager implements ISitemapUrlGeneratorManager {
-    private readonly policies;
-    constructor(searchApiClient: ISearchApiClient, organisationsClient: IOrganisationsClient);
-    generateUrls(): Promise<Map<FilterCombinations, string[]>>;
-}

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

@@ -1,34 +0,0 @@
-import { DependencyTypes } from '../enums/DependencyTypes';
-import { Area } from '../scholarships/policies/Area';
-import { Country } from '../scholarships/policies/Country';
-import { Discipline } from '../scholarships/policies/Discipline';
-import { DisciplineCountry } from '../scholarships/policies/DisciplineCountry';
-import { UniversityCountry } from '../scholarships/policies/UniversityCountry';
-import { Unfiltered } from '../scholarships/policies/Unfiltered';
-export class SitemapUrlGeneratorManager {
-    policies;
-    constructor(searchApiClient, organisationsClient) {
-        const dependencies = {
-            dependencyType: DependencyTypes.SITEMAP_GENERATOR,
-            searchApiClient,
-            organisationsClient
-        };
-        this.policies = [
-            new Area(dependencies),
-            new Country(dependencies),
-            new DisciplineCountry(dependencies),
-            new Discipline(dependencies),
-            new UniversityCountry(dependencies),
-            new Unfiltered(dependencies)
-        ];
-    }
-    async generateUrls() {
-        const map = new Map();
-        await Promise.all(this.policies.map(async (policy) => {
-            const filterCombination = policy.filterCombination;
-            const urls = await policy.generateSitemapUrls();
-            map.set(filterCombination, urls);
-        }));
-        return map;
-    }
-}