@studyportals/fawkes 1.0.1-3 → 1.0.1-7

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

@@ -1,2 +1,2 @@
-import { IFilterSelectionState, ISeoInfoBase } from "../src/common";
-export { IFilterSelectionState, ISeoInfoBase };
+import { ISeoFilterState, ISeoInfoBase } from "../src/common";
+export { ISeoFilterState, ISeoInfoBase };

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

@@ -1,11 +1,11 @@
-import { IFilterSelectionState } from "./IFilterSelectionState";
+import { ISeoFilterState } from "./ISeoFilterState";
 import { IPrettyPathGenerator } from "./IPrettyPathGenerator";
 import { ISeoIndexabilityPolicy } from "./ISeoIndexabilityPolicy";
 import { ISeoInfoBase } from "./ISeoInfoBase";
 export declare abstract class BaseSeoIndexabilityPolicy implements ISeoIndexabilityPolicy, IPrettyPathGenerator {
     protected readonly seoInfoBase: ISeoInfoBase;
-    protected readonly filterState: IFilterSelectionState;
-    constructor(seoInfoBase: ISeoInfoBase, filterState: IFilterSelectionState);
+    protected readonly filterState: ISeoFilterState;
+    constructor(seoInfoBase: ISeoInfoBase, filterState: ISeoFilterState);
     shouldIndex(): Promise<boolean>;
     abstract generatePaths(): string[];
     protected abstract matchesFilters(): Promise<boolean>;

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

@@ -1,4 +1,5 @@
 import { FilterKey } from "@studyportals/search-filters";
 export interface IFilterSelectionState {
-    identifySelectedFiltersFor(state: IFilterSelectionState): readonly FilterKey[];
+    getSelectedValuesFor(key: FilterKey): readonly string[];
+    getSelectedFilters(): readonly FilterKey[];
 }

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

@@ -0,0 +1,5 @@
+import { FilterKey } from "@studyportals/search-filters";
+export interface ISeoFilterState {
+    getSelectedValuesFor(key: FilterKey): readonly string[];
+    getSelectedFilters(): readonly FilterKey[];
+}

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

@@ -1,10 +1,8 @@
 import { FilterKey } from '@studyportals/search-filters';
-import { IFilterSelectionState } from './IFilterSelectionState';
+import { ISeoFilterState } from './ISeoFilterState';
 export interface ISeoInfoBase {
-    selectionOnlyFor(filterKeys: FilterKey[], filterSelectionState: IFilterSelectionState): Promise<boolean>;
-    singleSelectionFor(filterKey: FilterKey, filterSelectionState: IFilterSelectionState): Promise<boolean>;
-    getFilterOptionValueBy(filterKey: FilterKey, filterSelectionState: IFilterSelectionState): string | null;
-    getFilterOptionValueBy(filterKey: FilterKey, filterSelectionState: IFilterSelectionState): string | null;
-    getSelectionTypeCount(filterSelectionState: IFilterSelectionState): number;
-    getSelectedValuesFor(fiterKey: FilterKey, filterSelectionState: IFilterSelectionState): string[];
+    selectionOnlyFor(filterKeys: FilterKey[], filterSelectionState: ISeoFilterState): Promise<boolean>;
+    singleSelectionFor(filterKey: FilterKey, filterSelectionState: ISeoFilterState): Promise<boolean>;
+    getFilterOptionValueBy(filterKey: FilterKey, filterSelectionState: ISeoFilterState): string | null;
+    getSelectionTypeCount(filterSelectionState: ISeoFilterState): number;
 }

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

@@ -1,3 +1,3 @@
 import { ISeoInfoBase } from "./ISeoInfoBase";
-import { IFilterSelectionState } from "./IFilterSelectionState";
-export { ISeoInfoBase, IFilterSelectionState };
+import { ISeoFilterState } from "./ISeoFilterState";
+export { ISeoInfoBase, ISeoFilterState };

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

@@ -1,14 +1,14 @@
 import { BaseSeoIndexabilityPolicy } from "../common/BaseSeoIndexabilityPolicy";
-import { IFilterSelectionState } from "../common/IFilterSelectionState";
+import { ISeoFilterState } from "../common/ISeoFilterState";
 import { ISeoInfoBase } from "../common/ISeoInfoBase";
 import { IOrganisationsProvider } from "./IOrganisationsProvider";
 import { IRankingApiClient } from "@/sitemap-generator/IRankingApiClient";
 import { ISortState } from "./ISortState";
 export declare abstract class SeoIndexabilityPolicy<T> extends BaseSeoIndexabilityPolicy {
     protected readonly seoInfoBase: ISeoInfoBase;
-    protected readonly filterState: IFilterSelectionState;
+    protected readonly filterState: ISeoFilterState;
     protected readonly organisationsProvider: IOrganisationsProvider<T>;
     protected readonly rankingApiClient: IRankingApiClient;
     protected readonly sortState: ISortState;
-    constructor(seoInfoBase: ISeoInfoBase, filterState: IFilterSelectionState, organisationsProvider: IOrganisationsProvider<T>, rankingApiClient: IRankingApiClient, sortState: ISortState);
+    constructor(seoInfoBase: ISeoInfoBase, filterState: ISeoFilterState, organisationsProvider: IOrganisationsProvider<T>, rankingApiClient: IRankingApiClient, sortState: ISortState);
 }

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

@@ -1,5 +1,5 @@
 import { SeoIndexabilityPolicy } from "@/organisations/SeoIndexabilityPolicy";
-import { IFilterSelectionState } from "@/common/IFilterSelectionState";
+import { ISeoFilterState } from "@/common/ISeoFilterState";
 import { ISeoInfoBase } from "@/common/ISeoInfoBase";
 import { IOrganisationsProvider } from "@/organisations/IOrganisationsProvider";
 import { IRankingApiClient } from "@/sitemap-generator/IRankingApiClient";
@@ -7,10 +7,10 @@ import { FilterKeyValuePairs } from "@/organisations/FilterKeyValuePairs";
 import { ISortState } from "@/organisations/ISortState";
 export declare abstract class SeoRuleBasedIndexabilityPolicy<T> extends SeoIndexabilityPolicy<T> {
     protected readonly seoInfoBase: ISeoInfoBase;
-    protected readonly filterState: IFilterSelectionState;
+    protected readonly filterState: ISeoFilterState;
     protected readonly organisationsProvider: IOrganisationsProvider<T>;
     protected readonly rankingApiClient: IRankingApiClient;
     protected readonly sortState: ISortState;
-    constructor(seoInfoBase: ISeoInfoBase, filterState: IFilterSelectionState, organisationsProvider: IOrganisationsProvider<T>, rankingApiClient: IRankingApiClient, sortState: ISortState);
+    constructor(seoInfoBase: ISeoInfoBase, filterState: ISeoFilterState, organisationsProvider: IOrganisationsProvider<T>, rankingApiClient: IRankingApiClient, sortState: ISortState);
     protected abstract matchesRule(pairs: FilterKeyValuePairs, ...values: []): boolean;
 }

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

@@ -1,7 +1,7 @@
 import { ISearchPolicyChain } from "@/common/ISearchPolicyChain";
 import { ISeoIndexabilityPolicy } from "@/common/ISeoIndexabilityPolicy";
 import { ISeoInfoBase } from "@/common/ISeoInfoBase";
-import { IFilterSelectionState } from "@/common/IFilterSelectionState";
+import { ISeoFilterState } from "@/common/ISeoFilterState";
 import { ISearchApplicationState } from "@/common/ISearchApplicationState";
 import { IFilterOptions } from "@/common/IFilterOptions";
 export declare class SearchIndexabilityManager implements ISearchPolicyChain {
@@ -9,7 +9,7 @@ export declare class SearchIndexabilityManager implements ISearchPolicyChain {
     private readonly filterState;
     private readonly applicationState;
     private readonly filterOptions;
-    constructor(seoInfoBase: ISeoInfoBase, filterState: IFilterSelectionState, applicationState: ISearchApplicationState, filterOptions: IFilterOptions);
+    constructor(seoInfoBase: ISeoInfoBase, filterState: ISeoFilterState, applicationState: ISearchApplicationState, filterOptions: IFilterOptions);
     policies: ISeoIndexabilityPolicy[];
     shouldIndex(): Promise<boolean>;
 }

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

@@ -1,14 +1,14 @@
 import { BaseSeoIndexabilityPolicy } from '@/common/BaseSeoIndexabilityPolicy';
-import { IFilterSelectionState } from '@/common/IFilterSelectionState';
+import { ISeoFilterState } from '@/common/ISeoFilterState';
 import { ISeoInfoBase } from '@/common/ISeoInfoBase';
 import { ISeoIndexabilityPolicy } from '@/common/ISeoIndexabilityPolicy';
 import { IFilterOptions } from '@/common/IFilterOptions';
 export declare class AreaPolicy extends BaseSeoIndexabilityPolicy implements ISeoIndexabilityPolicy {
     protected readonly seoInfoBase: ISeoInfoBase;
-    protected readonly filterState: IFilterSelectionState;
+    protected readonly filterState: ISeoFilterState;
     protected readonly filterOptions: IFilterOptions;
     private static readonly AUSTRALIA_CODE;
-    constructor(seoInfoBase: ISeoInfoBase, filterState: IFilterSelectionState, filterOptions: IFilterOptions);
+    constructor(seoInfoBase: ISeoInfoBase, filterState: ISeoFilterState, filterOptions: IFilterOptions);
     protected matchesFilters(): Promise<boolean>;
     private isPartOfAustralia;
     generatePaths(): string[];

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

@@ -1,10 +1,10 @@
 import { BaseSeoIndexabilityPolicy } from '@/common/BaseSeoIndexabilityPolicy';
-import { IFilterSelectionState } from '@/common/IFilterSelectionState';
+import { ISeoFilterState } from '@/common/ISeoFilterState';
 import { ISeoInfoBase } from '@/common/ISeoInfoBase';
 export declare class CountryPolicy extends BaseSeoIndexabilityPolicy {
     protected readonly seoInfoBase: ISeoInfoBase;
-    protected readonly filterState: IFilterSelectionState;
-    constructor(seoInfoBase: ISeoInfoBase, filterState: IFilterSelectionState);
+    protected readonly filterState: ISeoFilterState;
+    constructor(seoInfoBase: ISeoInfoBase, filterState: ISeoFilterState);
     protected matchesFilters(): Promise<boolean>;
     generatePaths(): string[];
 }

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

@@ -1,10 +1,10 @@
 import { BaseSeoIndexabilityPolicy } from '@/common/BaseSeoIndexabilityPolicy';
-import { IFilterSelectionState } from '@/common/IFilterSelectionState';
+import { ISeoFilterState } from '@/common/ISeoFilterState';
 import { ISeoInfoBase } from '@/common/ISeoInfoBase';
 export declare class DisciplineAreaPolicy extends BaseSeoIndexabilityPolicy {
     protected readonly seoInfoBase: ISeoInfoBase;
-    protected readonly filterState: IFilterSelectionState;
-    constructor(seoInfoBase: ISeoInfoBase, filterState: IFilterSelectionState);
+    protected readonly filterState: ISeoFilterState;
+    constructor(seoInfoBase: ISeoInfoBase, filterState: ISeoFilterState);
     protected matchesFilters(): Promise<boolean>;
     generatePaths(): string[];
 }

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

@@ -1,12 +1,12 @@
 import { BaseSeoIndexabilityPolicy } from '@/common/BaseSeoIndexabilityPolicy';
 import { ISearchApplicationState } from '@/common/ISearchApplicationState';
-import { IFilterSelectionState } from '@/common/IFilterSelectionState';
+import { ISeoFilterState } from '@/common/ISeoFilterState';
 import { ISeoInfoBase } from '@/common/ISeoInfoBase';
 export declare class DisciplineCountryPolicy extends BaseSeoIndexabilityPolicy {
     protected readonly seoInfoBase: ISeoInfoBase;
-    protected readonly filterState: IFilterSelectionState;
+    protected readonly filterState: ISeoFilterState;
     protected readonly applicationState: ISearchApplicationState;
-    constructor(seoInfoBase: ISeoInfoBase, filterState: IFilterSelectionState, applicationState: ISearchApplicationState);
+    constructor(seoInfoBase: ISeoInfoBase, filterState: ISeoFilterState, applicationState: ISearchApplicationState);
     protected matchesFilters(): Promise<boolean>;
     private hasEnoughResults;
     generatePaths(): string[];

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

@@ -1,10 +1,10 @@
 import { BaseSeoIndexabilityPolicy } from '@/common/BaseSeoIndexabilityPolicy';
-import { IFilterSelectionState } from '@/common/IFilterSelectionState';
+import { ISeoFilterState } from '@/common/ISeoFilterState';
 import { ISeoInfoBase } from '@/common/ISeoInfoBase';
 export declare class DisciplinePolicy extends BaseSeoIndexabilityPolicy {
     protected readonly seoInfoBase: ISeoInfoBase;
-    protected readonly filterState: IFilterSelectionState;
-    constructor(seoInfoBase: ISeoInfoBase, filterState: IFilterSelectionState);
+    protected readonly filterState: ISeoFilterState;
+    constructor(seoInfoBase: ISeoInfoBase, filterState: ISeoFilterState);
     protected matchesFilters(): Promise<boolean>;
     generatePaths(): string[];
 }

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

@@ -1,10 +1,10 @@
 import { ISeoInfoBase } from '@/common/ISeoInfoBase';
-import { IFilterSelectionState } from '@/common/IFilterSelectionState';
+import { ISeoFilterState } from '@/common/ISeoFilterState';
 import { BaseSeoIndexabilityPolicy } from '@/common/BaseSeoIndexabilityPolicy';
 export declare class UnfilteredPolicy extends BaseSeoIndexabilityPolicy {
     protected readonly seoInfoBase: ISeoInfoBase;
-    protected readonly filterState: IFilterSelectionState;
-    constructor(seoInfoBase: ISeoInfoBase, filterState: IFilterSelectionState);
+    protected readonly filterState: ISeoFilterState;
+    constructor(seoInfoBase: ISeoInfoBase, filterState: ISeoFilterState);
     protected matchesFilters(): Promise<boolean>;
     generatePaths(): string[];
 }

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

@@ -1,10 +1,10 @@
 import { BaseSeoIndexabilityPolicy } from '@/common/BaseSeoIndexabilityPolicy';
-import { IFilterSelectionState } from '@/common/IFilterSelectionState';
+import { ISeoFilterState } from '@/common/ISeoFilterState';
 import { ISeoInfoBase } from '@/common/ISeoInfoBase';
 export declare class UniversityCountryPolicy extends BaseSeoIndexabilityPolicy {
     protected readonly seoInfoBase: ISeoInfoBase;
-    protected readonly filterState: IFilterSelectionState;
-    constructor(seoInfoBase: ISeoInfoBase, filterState: IFilterSelectionState);
+    protected readonly filterState: ISeoFilterState;
+    constructor(seoInfoBase: ISeoInfoBase, filterState: ISeoFilterState);
     protected matchesFilters(): Promise<boolean>;
     generatePaths(): string[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@studyportals/fawkes",
-	"version": "1.0.1-3",
+	"version": "1.0.1-7",
 	"description": "A package to centralize SEO related logic for SBLP and Sitemap Generator.",
 	"types": "dist/index.d.ts",
 	"main": "dist/fawkes.js",
@@ -23,7 +23,7 @@
 	},
 	"exports": {
 		"./organisations-search-seo": "./dist/organisations-seo.js",
-		"./scholarships-search-seo": "./dist/scholarships-seo.js",
+		"./dist/scholarships-search-seo": "./dist/scholarships-seo.js",
 		"./sitemap-generator-seo": "./dist/sitemap-generator-seo.js"
 	},
 	"typesVersions": {