@studyportals/fawkes 2.0.1-24 → 2.0.1-25

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

@@ -0,0 +1,8 @@
+import { ISeoInfoBase, ISeoFilterState, ISeoFilterOptions, ISeoSearchApplicationState } from "../common";
+import { IDependencies } from "./IDependencies";
+export interface ISearchDependencies extends IDependencies {
+    seoInfoBase: ISeoInfoBase;
+    filterState: ISeoFilterState;
+    filterOptions?: ISeoFilterOptions;
+    applicationState?: ISeoSearchApplicationState;
+}

package/dist/src/common/ISearchDependencies.js

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

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

@@ -1,10 +1,9 @@
 import { BaseSeoIndexabilityPolicy } from "./BaseSeoIndexabilityPolicy";
 import { SeoDependencies } from "../types/SeoDependencies";
-import { ICustomRule } from "./ICustomRule";
+import { ISearchDependencies } from "./ISearchDependencies";
 import { IFilterKeyValues } from "./IFilterKeyValues";
 export declare abstract class RuleBasedIndexabilityPolicy extends BaseSeoIndexabilityPolicy {
-    protected abstract rules: ICustomRule[];
     constructor(dependencies: SeoDependencies);
-    protected checksEveryRuleForSearch(filterKeyValues: IFilterKeyValues): boolean;
-    protected checksEveryRuleForSitemap(filterKeyValues: IFilterKeyValues): boolean;
+    protected abstract checksRulesForSearch(searchDependencies: ISearchDependencies): boolean;
+    protected abstract checksRulesForSitemap(filters?: IFilterKeyValues): boolean;
 }

package/dist/src/common/RuleBasedIndexabilityPolicy.js

@@ -3,10 +3,4 @@ export class RuleBasedIndexabilityPolicy extends BaseSeoIndexabilityPolicy {
     constructor(dependencies) {
         super(dependencies);
     }
-    checksEveryRuleForSearch(filterKeyValues) {
-        return this.rules.every(rule => rule.forSearch(filterKeyValues));
-    }
-    checksEveryRuleForSitemap(filterKeyValues) {
-        return this.rules.every(rule => rule.forSitemapGenerator(filterKeyValues));
-    }
 }

package/dist/src/scholarships/policies/AreaPolicy.d.ts

@@ -1,12 +1,14 @@
 import { FilterCombinations } from '../../enums/FilterCombinations';
 import { SeoDependencies } from '../../types/SeoDependencies';
+import { ISearchDependencies } from '../../common/ISearchDependencies';
 import { RuleBasedIndexabilityPolicy } from '../../common/RuleBasedIndexabilityPolicy';
-import { ICustomRule } from '../../common/ICustomRule';
 import { ISeoIndexabilityPolicy } from '../../common/ISeoIndexabilityPolicy';
+import { IFilterKeyValues } from '../../common/IFilterKeyValues';
 export declare class AreaPolicy extends RuleBasedIndexabilityPolicy implements ISeoIndexabilityPolicy {
-    protected rules: ICustomRule[];
     constructor(dependencies: SeoDependencies);
     protected matchesFilters(): Promise<boolean>;
     generateUrls(): Promise<string[]>;
     get filterCombination(): FilterCombinations;
+    protected checksRulesForSearch(dependencies: ISearchDependencies): boolean;
+    protected checksRulesForSitemap(filterKeyValues: IFilterKeyValues): boolean;
 }

package/dist/src/scholarships/policies/AreaPolicy.js

@@ -5,10 +5,6 @@ import { ExceptAustraliaAreasRule } from '../rules/ExceptAustaliaAreasRule';
 import { SearchVolumeAreasRule } from '../rules/SearchVolumeAreasRule';
 import { AreaPresenter } from '../../presenters/AreaPresenter';
 export class AreaPolicy extends RuleBasedIndexabilityPolicy {
-    rules = [
-        SearchVolumeAreasRule.getInstance(),
-        ExceptAustraliaAreasRule.getInstance()
-    ];
     constructor(dependencies) {
         super(dependencies);
     }
@@ -23,10 +19,7 @@ export class AreaPolicy extends RuleBasedIndexabilityPolicy {
             FilterKey.AREA,
             FilterKey.COUNTRY
         ], filterState);
-        const areaSelected = seoInfoBase.getFilterOptionValueBy(FilterKey.AREA, filterState);
-        const hasSearchVolumeAndNotAustralia = this.checksEveryRuleForSearch({
-            [FilterKey.AREA]: areaSelected ?? undefined
-        });
+        const hasSearchVolumeAndNotAustralia = this.checksRulesForSearch(this.dependencies);
         return singleAreaSelected
             && singleCountrySelected
             && onlyAreaAndCountrySelected
@@ -35,8 +28,9 @@ export class AreaPolicy extends RuleBasedIndexabilityPolicy {
     async generateUrls() {
         const areaFragments = AreaPresenter.getInstance().getFragments();
         const paths = areaFragments
-            .filter(area => this.checksEveryRuleForSitemap({
-            [FilterKey.COUNTRY]: area.countryId
+            .filter(area => this.checksRulesForSitemap({
+            [FilterKey.COUNTRY]: area.countryId,
+            [FilterKey.AREA]: area.id
         }))
             .map(area => area.path);
         return Promise.resolve(paths);
@@ -44,4 +38,24 @@ export class AreaPolicy extends RuleBasedIndexabilityPolicy {
     get filterCombination() {
         return FilterCombinations.AREA;
     }
+    checksRulesForSearch(dependencies) {
+        const { seoInfoBase, filterState } = dependencies;
+        const exceptAustraliaAreasRule = ExceptAustraliaAreasRule.getInstance();
+        const areaSelected = seoInfoBase.getFilterOptionValueBy(FilterKey.AREA, filterState);
+        const notInAustralia = exceptAustraliaAreasRule.forSearch({
+            [FilterKey.AREA]: areaSelected ?? undefined
+        });
+        const searchVolumeAreasRule = SearchVolumeAreasRule.getInstance();
+        const hasSearchVolume = searchVolumeAreasRule.forSearch({
+            [FilterKey.AREA]: areaSelected ?? undefined
+        });
+        return notInAustralia && hasSearchVolume;
+    }
+    checksRulesForSitemap(filterKeyValues) {
+        const exceptAustraliaAreasRule = ExceptAustraliaAreasRule.getInstance();
+        const notInAustralia = exceptAustraliaAreasRule.forSitemapGenerator(filterKeyValues);
+        const searchVolumeAreasRule = SearchVolumeAreasRule.getInstance();
+        const hasSearchVolume = searchVolumeAreasRule.forSitemapGenerator(filterKeyValues);
+        return notInAustralia && hasSearchVolume;
+    }
 }

package/dist/src/scholarships/policies/CountryPolicy.d.ts

@@ -1,12 +1,14 @@
 import { FilterCombinations } from '../../enums/FilterCombinations';
-import { ICustomRule } from '../../common/ICustomRule';
+import { ISearchDependencies } from '../../common/ISearchDependencies';
 import { SeoDependencies } from '../../types/SeoDependencies';
 import { RuleBasedIndexabilityPolicy } from '../../common/RuleBasedIndexabilityPolicy';
 import { ISeoIndexabilityPolicy } from '../../common/ISeoIndexabilityPolicy';
+import { IFilterKeyValues } from '../../common/IFilterKeyValues';
 export declare class CountryPolicy extends RuleBasedIndexabilityPolicy implements ISeoIndexabilityPolicy {
-    protected rules: ICustomRule[];
     constructor(dependencies: SeoDependencies);
     protected matchesFilters(): Promise<boolean>;
     generateUrls(): Promise<string[]>;
     get filterCombination(): FilterCombinations;
+    protected checksRulesForSearch(dependencies: ISearchDependencies): boolean;
+    protected checksRulesForSitemap(filters: IFilterKeyValues): boolean;
 }

package/dist/src/scholarships/policies/CountryPolicy.js

@@ -4,9 +4,6 @@ import { SearchVolumeCountriesRule } from '../rules/SearchVolumeCountriesRule';
 import { RuleBasedIndexabilityPolicy } from '../../common/RuleBasedIndexabilityPolicy';
 import { CountryPresenter } from '../../presenters/CountryPresenter';
 export class CountryPolicy extends RuleBasedIndexabilityPolicy {
-    rules = [
-        SearchVolumeCountriesRule.getInstance()
-    ];
     constructor(dependencies) {
         super(dependencies);
     }
@@ -16,10 +13,7 @@ export class CountryPolicy extends RuleBasedIndexabilityPolicy {
         const onlyCountrySelected = await seoInfoBase.selectionOnlyFor([
             FilterKey.COUNTRY
         ], filterState);
-        const countrySelected = seoInfoBase.getFilterOptionValueBy(FilterKey.COUNTRY, filterState);
-        const hasSearchVolume = this.checksEveryRuleForSearch({
-            [FilterKey.COUNTRY]: countrySelected ?? undefined
-        });
+        const hasSearchVolume = this.checksRulesForSearch(this.dependencies);
         return singleCountrySelected
             && onlyCountrySelected
             && hasSearchVolume;
@@ -27,7 +21,7 @@ export class CountryPolicy extends RuleBasedIndexabilityPolicy {
     generateUrls() {
         const countryFragments = CountryPresenter.getInstance().getFragments();
         const paths = countryFragments
-            .filter(country => this.checksEveryRuleForSitemap({
+            .filter(country => this.checksRulesForSitemap({
             [FilterKey.COUNTRY]: country.id
         }))
             .map(country => country.path);
@@ -36,4 +30,17 @@ export class CountryPolicy extends RuleBasedIndexabilityPolicy {
     get filterCombination() {
         return FilterCombinations.COUNTRY;
     }
+    checksRulesForSearch(dependencies) {
+        const { seoInfoBase, filterState } = dependencies;
+        const hasSearchVolumeRule = SearchVolumeCountriesRule.getInstance();
+        const countrySelected = seoInfoBase.getFilterOptionValueBy(FilterKey.COUNTRY, filterState);
+        const hasSearchVolume = hasSearchVolumeRule.forSearch({
+            [FilterKey.COUNTRY]: countrySelected ?? undefined
+        });
+        return hasSearchVolume;
+    }
+    checksRulesForSitemap(filters) {
+        const hasSearchVolumeRule = SearchVolumeCountriesRule.getInstance();
+        return hasSearchVolumeRule.forSitemapGenerator(filters);
+    }
 }

package/dist/src/scholarships/policies/DisciplineCountryPolicy.d.ts

@@ -1,12 +1,14 @@
 import { ISeoIndexabilityPolicy } from '../../common/ISeoIndexabilityPolicy';
 import { FilterCombinations } from '../../enums/FilterCombinations';
 import { SeoDependencies } from '../../types/SeoDependencies';
+import { ISearchDependencies } from '../../common/ISearchDependencies';
 import { RuleBasedIndexabilityPolicy } from '../../common/RuleBasedIndexabilityPolicy';
-import { ICustomRule } from '../../common/ICustomRule';
+import { IFilterKeyValues } from '../../common/IFilterKeyValues';
 export declare class DisciplineCountryPolicy extends RuleBasedIndexabilityPolicy implements ISeoIndexabilityPolicy {
-    protected rules: ICustomRule[];
     constructor(dependencies: SeoDependencies);
     protected matchesFilters(): Promise<boolean>;
     generateUrls(): Promise<string[]>;
     get filterCombination(): FilterCombinations;
+    protected checksRulesForSearch(dependencies: ISearchDependencies): boolean;
+    protected checksRulesForSitemap(filters: IFilterKeyValues): boolean;
 }

package/dist/src/scholarships/policies/DisciplineCountryPolicy.js

@@ -4,9 +4,6 @@ import { RuleBasedIndexabilityPolicy } from '../../common/RuleBasedIndexabilityP
 import { SearchVolumeCountriesDisciplinesRule } from '../rules/SearchVolumeCountryDisciplineRule';
 import { CountryPresenter } from '../../presenters/CountryPresenter';
 export class DisciplineCountryPolicy extends RuleBasedIndexabilityPolicy {
-    rules = [
-        SearchVolumeCountriesDisciplinesRule.getInstance()
-    ];
     constructor(dependencies) {
         super(dependencies);
     }
@@ -21,12 +18,7 @@ export class DisciplineCountryPolicy extends RuleBasedIndexabilityPolicy {
             FilterKey.DISCIPLINES,
             FilterKey.COUNTRY
         ], filterState);
-        const countrySelected = seoInfoBase.getFilterOptionValueBy(FilterKey.COUNTRY, filterState);
-        const disciplineSelected = seoInfoBase.getFilterOptionValueBy(FilterKey.DISCIPLINES, filterState);
-        const hasSearchVolume = this.checksEveryRuleForSearch({
-            [FilterKey.COUNTRY]: countrySelected ?? undefined,
-            [FilterKey.DISCIPLINES]: disciplineSelected ?? undefined
-        });
+        const hasSearchVolume = this.checksRulesForSearch(this.dependencies);
         return singleDisciplineSelected
             && singleCountrySelected
             && onlyDisciplineAndCountrySelected
@@ -38,7 +30,7 @@ export class DisciplineCountryPolicy extends RuleBasedIndexabilityPolicy {
         const disciplineFragments = CountryPresenter.getInstance().getFragments();
         countryFragments.forEach(country => {
             disciplineFragments.forEach(discipline => {
-                if (this.checksEveryRuleForSitemap({
+                if (this.checksRulesForSitemap({
                     [FilterKey.COUNTRY]: country.id,
                     [FilterKey.DISCIPLINES]: discipline.id
                 })) {
@@ -51,4 +43,19 @@ export class DisciplineCountryPolicy extends RuleBasedIndexabilityPolicy {
     get filterCombination() {
         return FilterCombinations.DISCIPLINE_COUNTRY;
     }
+    checksRulesForSearch(dependencies) {
+        const { seoInfoBase, filterState } = dependencies;
+        const countrySelected = seoInfoBase.getFilterOptionValueBy(FilterKey.COUNTRY, filterState);
+        const disciplineSelected = seoInfoBase.getFilterOptionValueBy(FilterKey.DISCIPLINES, filterState);
+        const searchVolumeRule = SearchVolumeCountriesDisciplinesRule.getInstance();
+        const hasSearchVolume = searchVolumeRule.forSearch({
+            [FilterKey.COUNTRY]: countrySelected ?? undefined,
+            [FilterKey.DISCIPLINES]: disciplineSelected ?? undefined
+        });
+        return hasSearchVolume;
+    }
+    checksRulesForSitemap(filters) {
+        const searchVolumeRule = SearchVolumeCountriesDisciplinesRule.getInstance();
+        return searchVolumeRule.forSitemapGenerator(filters);
+    }
 }

package/dist/src/scholarships/policies/DisciplinePolicy.d.ts

@@ -1,12 +1,14 @@
 import { SeoDependencies } from '../../types/SeoDependencies';
-import { ICustomRule } from '../../common/ICustomRule';
+import { ISearchDependencies } from '../../common/ISearchDependencies';
 import { ISeoIndexabilityPolicy } from '../../common/ISeoIndexabilityPolicy';
 import { FilterCombinations } from '../../enums/FilterCombinations';
 import { RuleBasedIndexabilityPolicy } from '../../common/RuleBasedIndexabilityPolicy';
+import { IFilterKeyValues } from '../../common/IFilterKeyValues';
 export declare class DisciplinePolicy extends RuleBasedIndexabilityPolicy implements ISeoIndexabilityPolicy {
-    protected rules: ICustomRule[];
     constructor(dependencies: SeoDependencies);
     protected matchesFilters(): Promise<boolean>;
     generateUrls(): Promise<string[]>;
     get filterCombination(): FilterCombinations;
+    protected checksRulesForSearch(dependencies: ISearchDependencies): boolean;
+    protected checksRulesForSitemap(filters: IFilterKeyValues): boolean;
 }

package/dist/src/scholarships/policies/DisciplinePolicy.js

@@ -4,12 +4,8 @@ import { SearchVolumeDisciplinesRule } from '../../scholarships/rules/SearchVolu
 import { FilterCombinations } from '../../enums/FilterCombinations';
 import { RuleBasedIndexabilityPolicy } from '../../common/RuleBasedIndexabilityPolicy';
 export class DisciplinePolicy extends RuleBasedIndexabilityPolicy {
-    rules;
     constructor(dependencies) {
         super(dependencies);
-        this.rules = [
-            SearchVolumeDisciplinesRule.getInstance(),
-        ];
     }
     async matchesFilters() {
         const { seoInfoBase, filterState } = this.dependencies;
@@ -17,10 +13,7 @@ export class DisciplinePolicy extends RuleBasedIndexabilityPolicy {
         const onlyDisciplineSelected = await seoInfoBase.selectionOnlyFor([
             FilterKey.DISCIPLINES
         ], filterState);
-        const disciplineSelected = seoInfoBase.getFilterOptionValueBy(FilterKey.DISCIPLINES, filterState);
-        const hasSearchVolume = this.checksEveryRuleForSearch({
-            [FilterKey.DISCIPLINES]: disciplineSelected ?? undefined
-        });
+        const hasSearchVolume = this.checksRulesForSearch(this.dependencies);
         return singleDisciplineSelected
             && onlyDisciplineSelected
             && hasSearchVolume;
@@ -28,7 +21,7 @@ export class DisciplinePolicy extends RuleBasedIndexabilityPolicy {
     generateUrls() {
         const disciplineFragments = DisciplinePresenter.getInstance().getFragments();
         const paths = disciplineFragments
-            .filter(discipline => this.checksEveryRuleForSitemap({
+            .filter(discipline => this.checksRulesForSitemap({
             [FilterKey.DISCIPLINES]: discipline.id
         }))
             .map(discipline => discipline.path);
@@ -37,4 +30,17 @@ export class DisciplinePolicy extends RuleBasedIndexabilityPolicy {
     get filterCombination() {
         return FilterCombinations.DISCIPLINE;
     }
+    checksRulesForSearch(dependencies) {
+        const { seoInfoBase, filterState } = dependencies;
+        const hasSearchVolumeRule = SearchVolumeDisciplinesRule.getInstance();
+        const disciplineSelected = seoInfoBase.getFilterOptionValueBy(FilterKey.DISCIPLINES, filterState);
+        const hasSearchVolume = hasSearchVolumeRule.forSearch({
+            [FilterKey.DISCIPLINES]: disciplineSelected ?? undefined
+        });
+        return hasSearchVolume;
+    }
+    checksRulesForSitemap(filters) {
+        const hasSearchVolumeRule = SearchVolumeDisciplinesRule.getInstance();
+        return hasSearchVolumeRule.forSitemapGenerator(filters);
+    }
 }

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

@@ -0,0 +1,7 @@
+import { IDependencies } from "../common/IDependencies";
+import { ISearchApiClient } from "./ISearchApiClient";
+import { IOrganisationsClient } from "./IOrganisationsClient";
+export interface ISitemapDependencies extends IDependencies {
+    searchApiClient?: ISearchApiClient;
+    organisationsClient?: IOrganisationsClient;
+}

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

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

package/dist/src/types/SeoDependencies.d.ts

@@ -1,3 +1,3 @@
-import { IIndexabilityPolicyDependencies } from "../common/IIndexabilityPolicyDependencies";
-import { ISitemapUrlGeneratorDependencies } from "../sitemap-generator/ISitemapUrlGeneratorDependencies";
-export type SeoDependencies = IIndexabilityPolicyDependencies | ISitemapUrlGeneratorDependencies;
+import { ISearchDependencies } from "../common/ISearchDependencies";
+import { ISitemapDependencies } from "../sitemap-generator/ISitemapDependencies";
+export type SeoDependencies = ISearchDependencies | ISitemapDependencies;

package/package.json

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