@studyportals/fawkes 4.0.1-1 → 4.0.1-3

package/dist/scholarships-seo/index.d.ts

@@ -1,6 +1,7 @@
 import { ISeoFilterState } from '../src/common/ISeoFilterState';
 import { ISeoInfoBase } from '../src/common/ISeoInfoBase';
 import { ISearchIndexabilityManager } from '../src/common/ISearchIndexabilityManager';
+import { ISeoIndexabilityPolicy } from '../src/common/ISeoIndexabilityPolicy';
 import { SearchIndexabilityManager } from '../src/scholarships/SearchIndexabilityManager';
 import { types } from '../src/scholarships/types';
-export { ISeoFilterState, ISeoInfoBase, ISearchIndexabilityManager, SearchIndexabilityManager, types };
+export { ISeoFilterState, ISeoInfoBase, ISearchIndexabilityManager, SearchIndexabilityManager, types, ISeoIndexabilityPolicy };

package/dist/sitemap-generator-seo/index.d.ts

@@ -5,4 +5,5 @@ import { ISitemapUrlGeneratorManager } from '../src/sitemap-generator/ISitemapUr
 import { OrganisationsSitemapUrlGeneratorManager } from '../src/sitemap-generator/OrganisationsSitemapUrlGeneratorManager';
 import { ScholarshipsSitemapUrlGeneratorManager } from '../src/sitemap-generator/ScholarshipsSitemapUrlGeneratorManager';
 import { FilterCombinations } from '../src/enums/FilterCombinations';
-export { IOrganisationsClient, IOrganisation, ISearchApiClient, ISitemapUrlGeneratorManager, OrganisationsSitemapUrlGeneratorManager, ScholarshipsSitemapUrlGeneratorManager, FilterCombinations };
+import { ISitemapUrlGenerator } from '../src/common/ISitemapUrlGenerator';
+export { IOrganisationsClient, IOrganisation, ISearchApiClient, ISitemapUrlGeneratorManager, OrganisationsSitemapUrlGeneratorManager, ScholarshipsSitemapUrlGeneratorManager, FilterCombinations, ISitemapUrlGenerator };

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

@@ -0,0 +1,5 @@
+import { ISeoIndexabilityPolicy } from "./ISeoIndexabilityPolicy";
+import { ISitemapUrlGenerator } from "./ISitemapUrlGenerator";
+export interface IDocumentationManager {
+    getPolicies(): ISitemapUrlGenerator[] | ISeoIndexabilityPolicy[];
+}

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

@@ -4,4 +4,5 @@ export interface IRule {
     getName(): string;
     forSearch(dependencies: ISearchDependencies): Promise<boolean>;
     forSitemapGenerator(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
+    getDescription(): string;
 }

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

@@ -1,3 +1,4 @@
-export interface ISearchIndexabilityManager {
+import { IDocumentationManager } from "./IDocumentationManager";
+export interface ISearchIndexabilityManager extends IDocumentationManager {
     shouldIndex(): Promise<boolean>;
 }

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

@@ -18,4 +18,5 @@ export declare abstract class BaseSeoIndexabilityPolicy<TDependencies extends ID
     protected checkRulesForSitemap(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
     protected isIndexabilityPolicyDependencies(): boolean;
     protected isSitemapUrlGeneratorDependencies(): boolean;
+    get allRules(): IRule[];
 }

package/dist/src/common/policies/BaseSeoIndexabilityPolicy.js

@@ -44,4 +44,7 @@ export class BaseSeoIndexabilityPolicy {
     isSitemapUrlGeneratorDependencies() {
         return this.dependencies.dependencyType === DependencyTypes.SITEMAP_GENERATOR;
     }
+    get allRules() {
+        return this.rules;
+    }
 }

package/dist/src/common/rules/BaseFilterKeyValueRule.d.ts

@@ -5,6 +5,7 @@ export declare abstract class BaseFilterKeyValueRule implements IRule {
     private readonly expectedFilterKeyValues;
     constructor(expectedFilterKeyValues: FilterKeyValuesMap);
     abstract getName(): string;
+    abstract getDescription(): string;
     forSearch(dependencies: ISearchDependencies): Promise<boolean>;
     forSitemapGenerator(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
 }

package/dist/src/common/rules/NoFiltersSelectedRule.d.ts

@@ -5,4 +5,5 @@ export declare class NoFiltersSelectedRule implements IRule {
     forSearch(dependencies: ISearchDependencies): Promise<boolean>;
     forSitemapGenerator(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
     getName(): string;
+    getDescription(): string;
 }

package/dist/src/common/rules/NoFiltersSelectedRule.js

@@ -11,4 +11,7 @@ export class NoFiltersSelectedRule {
     getName() {
         return 'NoFiltersSelectedRule';
     }
+    getDescription() {
+        return 'No filters are selected';
+    }
 }

package/dist/src/common/rules/OnlyFiltersSelectedRule.d.ts

@@ -8,4 +8,5 @@ export declare class OnlyFiltersSelectedRule implements IRule {
     getName(): string;
     forSearch(dependencies: ISearchDependencies): Promise<boolean>;
     forSitemapGenerator(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
+    getDescription(): string;
 }

package/dist/src/common/rules/OnlyFiltersSelectedRule.js

@@ -24,4 +24,7 @@ export class OnlyFiltersSelectedRule {
         }
         return Promise.resolve(true);
     }
+    getDescription() {
+        return `Only ${this.filterKeys.join(', ')} filters are selected`;
+    }
 }

package/dist/src/common/rules/SingleValueSelectedForFilterRule.d.ts

@@ -8,4 +8,5 @@ export declare class SingleValueSelectedForFilterRule implements IRule {
     getName(): string;
     forSearch(dependencies: ISearchDependencies): Promise<boolean>;
     forSitemapGenerator(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
+    getDescription(): string;
 }

package/dist/src/common/rules/SingleValueSelectedForFilterRule.js

@@ -18,4 +18,7 @@ export class SingleValueSelectedForFilterRule {
         }
         return Promise.resolve(true);
     }
+    getDescription() {
+        return `Single value is selected for filter ${this.filterKey}`;
+    }
 }

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

@@ -8,4 +8,5 @@ export declare class SearchIndexabilityManager implements ISearchIndexabilityMan
     policies: ISeoIndexabilityPolicy[];
     constructor(portalType: PortalType, seoInfoBase: ISeoInfoBase, filterState: ISeoFilterState, sortingState: ISeoSortingState, applicationState: IOrganisationSearchApplicationState);
     shouldIndex(): Promise<boolean>;
+    getPolicies(): ISeoIndexabilityPolicy[];
 }

package/dist/src/organisations/SearchIndexabilityManager.js

@@ -36,4 +36,7 @@ export class SearchIndexabilityManager {
         const results = await Promise.all(this.policies.map((policy) => policy.shouldIndex()));
         return results.some((result) => result);
     }
+    getPolicies() {
+        return this.policies;
+    }
 }

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

@@ -9,4 +9,5 @@ export declare class AtLeastTwoRankedResultsRule implements IRule {
     forSearch(dependencies: IOrganisationSearchDependencies): Promise<boolean>;
     forSitemapGenerator(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
     getName(): string;
+    getDescription(): string;
 }

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

@@ -20,4 +20,7 @@ export class AtLeastTwoRankedResultsRule {
     getName() {
         return 'AtLeastTwoRankedResultsRule';
     }
+    getDescription() {
+        return `At least ${this.minimumRankedResultsCount} ranked results are available`;
+    }
 }

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

@@ -10,4 +10,5 @@ export declare abstract class BaseSearchVolumeOrganisationsRule implements IRule
     forSearch(dependencies: ISearchDependencies): Promise<boolean>;
     forSitemapGenerator(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
     private hasSearchVolume;
+    getDescription(): string;
 }

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

@@ -27,4 +27,7 @@ export class BaseSearchVolumeOrganisationsRule {
     hasSearchVolume(value) {
         return this.idsWithSearchVolume.includes(value);
     }
+    getDescription() {
+        return `Indexable if ${this.filterKey} has search volume`;
+    }
 }

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

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

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

@@ -9,4 +9,7 @@ export class ContinentIsEuropeRule extends BaseFilterKeyValueRule {
     getName() {
         return 'ContinentIsEuropeRule';
     }
+    getDescription() {
+        return 'Indexable if continent is Europe';
+    }
 }

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/organisations/rules/SearchVolumeAreasAttendanceRule.d.ts

@@ -2,4 +2,5 @@ import { BaseSearchVolumeOrganisationsRule } from './BaseSearchVolumeOrganisatio
 export declare class SearchVolumeAreasAttendanceRule extends BaseSearchVolumeOrganisationsRule {
     constructor();
     getName(): string;
+    getDescription(): string;
 }

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

@@ -11,4 +11,7 @@ export class SearchVolumeAreasAttendanceRule extends BaseSearchVolumeOrganisatio
     getName() {
         return 'SearchVolumeAreasAttendanceRule';
     }
+    getDescription() {
+        return 'Indexable if area has search volume';
+    }
 }

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

@@ -2,4 +2,5 @@ import { BaseSearchVolumeOrganisationsRule } from './BaseSearchVolumeOrganisatio
 export declare class SearchVolumeAreasDisciplineRule extends BaseSearchVolumeOrganisationsRule {
     constructor();
     getName(): string;
+    getDescription(): string;
 }

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

@@ -12,4 +12,7 @@ export class SearchVolumeAreasDisciplineRule extends BaseSearchVolumeOrganisatio
     getName() {
         return 'SearchVolumeAreasDisciplineRule';
     }
+    getDescription() {
+        return 'Indexable if area has search volume';
+    }
 }

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

@@ -2,4 +2,5 @@ import { BaseSearchVolumeOrganisationsRule } from './BaseSearchVolumeOrganisatio
 export declare class SearchVolumeCountriesAttendanceRule extends BaseSearchVolumeOrganisationsRule {
     constructor();
     getName(): string;
+    getDescription(): string;
 }

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

@@ -11,4 +11,7 @@ export class SearchVolumeCountriesAttendanceRule extends BaseSearchVolumeOrganis
     getName() {
         return 'SearchVolumeCountriesAttendanceRule';
     }
+    getDescription() {
+        return 'Indexable if country has search volume';
+    }
 }

package/dist/src/scholarships/SearchIndexabilityManager.d.ts

@@ -1,3 +1,4 @@
+import { ISeoIndexabilityPolicy } from '../common/ISeoIndexabilityPolicy';
 import { ISeoInfoBase } from '../common/ISeoInfoBase';
 import { ISeoFilterState } from '../common/ISeoFilterState';
 import { ISearchApplicationState } from '../common/ISearchApplicationState';
@@ -6,4 +7,5 @@ export declare class SearchIndexabilityManager implements ISearchIndexabilityMan
     private policies;
     constructor(seoInfoBase: ISeoInfoBase, filterState: ISeoFilterState, applicationState: ISearchApplicationState);
     shouldIndex(): Promise<boolean>;
+    getPolicies(): ISeoIndexabilityPolicy[];
 }

package/dist/src/scholarships/SearchIndexabilityManager.js

@@ -27,4 +27,7 @@ export class SearchIndexabilityManager {
         const results = await Promise.all(this.policies.map((policy) => policy.shouldIndex()));
         return results.some((result) => result);
     }
+    getPolicies() {
+        return this.policies;
+    }
 }

package/dist/src/scholarships/rules/ExceptAustaliaAreasRule.d.ts

@@ -10,4 +10,5 @@ export declare class ExceptAustraliaAreasRule implements IRule {
     forSitemapGenerator(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
     private isNotAustralia;
     private doesNotBelongToAustralia;
+    getDescription(): string;
 }

package/dist/src/scholarships/rules/ExceptAustaliaAreasRule.js

@@ -36,4 +36,7 @@ export class ExceptAustraliaAreasRule {
         }
         return foundArea.countryId !== this.australiaCountryId.toString();
     }
+    getDescription() {
+        return 'Area does not belong to Australia';
+    }
 }

package/dist/src/scholarships/rules/SearchVolumeAreasRule.d.ts

@@ -8,4 +8,5 @@ export declare class SearchVolumeAreasRule implements IRule {
     forSearch(dependencies: ISearchDependencies): Promise<boolean>;
     forSitemapGenerator(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
     private hasSearchVolume;
+    getDescription(): string;
 }

package/dist/src/scholarships/rules/SearchVolumeAreasRule.js

@@ -26,4 +26,7 @@ export class SearchVolumeAreasRule {
     hasSearchVolume(areaId) {
         return !this.areasWithNoSearchVolume.includes(Number(areaId));
     }
+    getDescription() {
+        return `Search volume is not available for the areas with id ${this.areasWithNoSearchVolume.join(', ')}`;
+    }
 }

package/dist/src/scholarships/rules/SearchVolumeCountriesDisciplinesRule.d.ts

@@ -10,4 +10,5 @@ export declare class SearchVolumeCountriesDisciplinesRule implements IRule {
     forSearch(dependencies: ISearchDependencies): Promise<boolean>;
     forSitemapGenerator(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
     private hasSearchVolume;
+    getDescription(): string;
 }

package/dist/src/scholarships/rules/SearchVolumeCountriesDisciplinesRule.js

@@ -37,4 +37,7 @@ export class SearchVolumeCountriesDisciplinesRule {
     hasSearchVolume(countryId, disciplineId) {
         return this.combinationsWithSearchVolume.has(`${countryId},${disciplineId}`);
     }
+    getDescription() {
+        return 'Search volume is available for the selected country and discipline';
+    }
 }

package/dist/src/scholarships/rules/SearchVolumeCountriesRule.d.ts

@@ -8,4 +8,5 @@ export declare class SearchVolumeCountriesRule implements IRule {
     forSearch(dependencies: ISearchDependencies): Promise<boolean>;
     forSitemapGenerator(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
     private hasSearchVolume;
+    getDescription(): string;
 }

package/dist/src/scholarships/rules/SearchVolumeCountriesRule.js

@@ -26,4 +26,7 @@ export class SearchVolumeCountriesRule {
     hasSearchVolume(countryId) {
         return !this.countriesWithNoSearchVolume.includes(Number(countryId));
     }
+    getDescription() {
+        return `Search volume is not available for the countries with id ${this.countriesWithNoSearchVolume.join(', ')}`;
+    }
 }

package/dist/src/scholarships/rules/SearchVolumeDisciplinesRule.d.ts

@@ -8,4 +8,5 @@ export declare class SearchVolumeDisciplinesRule implements IRule {
     forSearch(dependencies: ISearchDependencies): Promise<boolean>;
     forSitemapGenerator(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
     private hasSearchVolume;
+    getDescription(): string;
 }

package/dist/src/scholarships/rules/SearchVolumeDisciplinesRule.js

@@ -26,4 +26,7 @@ export class SearchVolumeDisciplinesRule {
     hasSearchVolume(disciplineId) {
         return !this.disciplinesWithNoSearchVolume.includes(Number(disciplineId));
     }
+    getDescription() {
+        return `Search volume is not available for the disciplines with id ${this.disciplinesWithNoSearchVolume.join(', ')}`;
+    }
 }

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

@@ -4,4 +4,5 @@ import { FilterCombinations } from '../enums/FilterCombinations';
 export declare abstract class BaseSitemapUrlGeneratorManager implements ISitemapUrlGeneratorManager {
     abstract readonly policies: ISitemapUrlGenerator[];
     generateUrls(): Promise<Map<FilterCombinations, string[]>>;
+    getPolicies(): ISitemapUrlGenerator[];
 }

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

@@ -8,4 +8,7 @@ export class BaseSitemapUrlGeneratorManager {
         }));
         return map;
     }
+    getPolicies() {
+        return this.policies;
+    }
 }

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

@@ -1,4 +1,5 @@
+import { IDocumentationManager } from '../common/IDocumentationManager';
 import { FilterCombinations } from '../enums/FilterCombinations';
-export interface ISitemapUrlGeneratorManager {
+export interface ISitemapUrlGeneratorManager extends IDocumentationManager {
     generateUrls(): Promise<Map<FilterCombinations, string[]>>;
 }

package/package.json

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

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;
-    }
-}