@studyportals/fawkes 7.5.1-0 → 7.5.1-3

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

@@ -0,0 +1,19 @@
+import { FilterKey } from '@studyportals/search-filters/server-side';
+import { DurationFilterOptionValue } from '@studyportals/search-filters/server-side';
+import { BaseProgrammeFilterKeyValueRule } from '../BaseProgrammeFilterKeyValueRule';
+export class OneOrTwoYearDurationRule extends BaseProgrammeFilterKeyValueRule {
+    constructor() {
+        const filterKeyValues = new Map([[
+                FilterKey.DURATION,
+                [DurationFilterOptionValue.ONE_YEAR, DurationFilterOptionValue.TWO_YEARS]
+            ]
+        ]);
+        super(filterKeyValues);
+    }
+    getName() {
+        return 'OneOrTwoYearDurationRule';
+    }
+    getDescription() {
+        return 'Is indexable if the selected duration is one or two years.';
+    }
+}

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

@@ -0,0 +1,6 @@
+import { BaseProgrammeFilterKeyValueRule } from '../BaseProgrammeFilterKeyValueRule';
+export declare class TwoYearDurationRule extends BaseProgrammeFilterKeyValueRule {
+    constructor();
+    getName(): string;
+    getDescription(): string;
+}

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

@@ -0,0 +1,19 @@
+import { FilterKey } from '@studyportals/search-filters/server-side';
+import { DurationFilterOptionValue } from '@studyportals/search-filters/server-side';
+import { BaseProgrammeFilterKeyValueRule } from '../BaseProgrammeFilterKeyValueRule';
+export class TwoYearDurationRule extends BaseProgrammeFilterKeyValueRule {
+    constructor() {
+        const filterKeyValues = new Map([[
+                FilterKey.DURATION,
+                [DurationFilterOptionValue.TWO_YEARS]
+            ]
+        ]);
+        super(filterKeyValues);
+    }
+    getName() {
+        return 'TwoYearDurationRule';
+    }
+    getDescription() {
+        return 'Is indexable if the selected duration is two years.';
+    }
+}

package/package.json

@@ -1,105 +1,105 @@
-{
-	"name": "@studyportals/fawkes",
-	"version": "7.5.1-0",
-	"description": "A package to centralize SEO related logic for SBLP and Sitemap Generator.",
-	"files": [
-		"./dist"
-	],
-	"scripts": {
-		"prepush": "npm run test",
-		"precommit": "npm run lint",
-		"compile": "npx tsc && tsc-alias && rm -r ./dist/tests",
-		"build": "npm run clean && npm run compile",
-		"clean": "rimraf \"!(node_modules)/**/dist\"",
-		"prepare-deployment": "npm run test && npm run build",
-		"publish-major": "npm run prepare-deployment && npm version major && npm publish",
-		"publish-beta": "npm run prepare-deployment && npm version prerelease && npm publish --tag beta --access=public",
-		"publish-patch": "npm run prepare-deployment && npm version patch && npm publish",
-		"publish-minor": "npm run prepare-deployment && npm version minor && npm publish",
-		"prepare": "husky install",
-		"test": "vitest run --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 ."
-	},
-	"exports": {
-		"./organisations-search-seo": {
-			"import": "./dist/organisations-seo/index.js",
-			"require": "./dist/organisations-seo/index.js",
-			"types": "./dist/organisations-seo/index.d.ts"
-		},
-		"./programmes-search-seo": {
-			"import": "./dist/programmes-seo/index.js",
-			"require": "./dist/programmes-seo/index.js",
-			"types": "./dist/programmes-seo/index.d.ts"
-		},
-		"./scholarships-search-seo": {
-			"import": "./dist/scholarships-seo/index.js",
-			"require": "./dist/scholarships-seo/index.js",
-			"types": "./dist/scholarships-seo/index.d.ts"
-		},
-		"./sitemap-generator-seo": {
-			"import": "./dist/sitemap-generator-seo/index.js",
-			"require": "./dist/sitemap-generator-seo/index.js",
-			"types": "./dist/sitemap-generator-seo/index.d.ts"
-		},
-		"./structured-data-seo": {
-			"import": "./dist/structured-data-seo/index.js",
-			"require": "./dist/structured-data-seo/index.js",
-			"types": "./dist/structured-data-seo/index.d.ts"
-		}
-	},
-	"typesVersions": {
-		"*": {
-			"organisations-search-seo": [
-				"dist/organisations-seo/index.d.ts"
-			],
-			"programmes-search-seo": [
-				"dist/programmes-seo/index.d.ts"
-			],
-			"scholarships-search-seo": [
-				"dist/scholarships-seo/index.d.ts"
-			],
-			"sitemap-generator-seo": [
-				"dist/sitemap-generator-seo/index.d.ts"
-			],
-			"structured-data-seo": [
-				"dist/structured-data-seo/index.d.ts"
-			],
-			"*": [
-				"dist/index.d.ts"
-			]
-		}
-	},
-	"author": "The Jedi Council",
-	"license": "ISC",
-	"devDependencies": {
-		"@adobe/structured-data-validator": "^1.4.1",
-		"@studyportals/code-style": "^2.2.1",
-		"@studyportals/webpack-helper": "^6.0.6",
-		"@vitest/coverage-istanbul": "^2.1.8",
-		"husky": "^8.0.3",
-		"jsdom": "^26.0.0",
-		"prettier": "^3.5.3",
-		"schema-dts": "^1.1.5",
-		"ts-loader": "^9.5.2",
-		"tsc-alias": "^1.8.11",
-		"typemoq": "^2.1.0",
-		"typescript": "^5.7.3",
-		"vitest": "^2.1.8"
-	},
-	"dependencies": {
-		"@studyportals/domain-client": "7.1.0",
-		"@studyportals/ranking-api-interface": "^1.3.12",
-		"@studyportals/search-filters": "^6.1.0",
-		"@studyportals/static-domain-data": "^6.1.0"
-	},
-	"optionalDependencies": {
-		"@rollup/rollup-linux-x64-gnu": "4.24.0"
-	},
-	"engines": {
-		"node": ">=18 <=22",
-		"npm": ">=8 <=10"
-	}
-}
+{
+	"name": "@studyportals/fawkes",
+	"version": "7.5.1-3",
+	"description": "A package to centralize SEO related logic for SBLP and Sitemap Generator.",
+	"files": [
+		"./dist"
+	],
+	"scripts": {
+		"prepush": "npm run test",
+		"precommit": "npm run lint",
+		"compile": "npx tsc && tsc-alias && rm -r ./dist/tests",
+		"build": "npm run clean && npm run compile",
+		"clean": "rimraf \"!(node_modules)/**/dist\"",
+		"prepare-deployment": "npm run test && npm run build",
+		"publish-major": "npm run prepare-deployment && npm version major && npm publish",
+		"publish-beta": "npm run prepare-deployment && npm version prerelease && npm publish --tag beta --access=public",
+		"publish-patch": "npm run prepare-deployment && npm version patch && npm publish",
+		"publish-minor": "npm run prepare-deployment && npm version minor && npm publish",
+		"prepare": "husky install",
+		"test": "vitest run --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 ."
+	},
+	"exports": {
+		"./organisations-search-seo": {
+			"import": "./dist/organisations-seo/index.js",
+			"require": "./dist/organisations-seo/index.js",
+			"types": "./dist/organisations-seo/index.d.ts"
+		},
+		"./programmes-search-seo": {
+			"import": "./dist/programmes-seo/index.js",
+			"require": "./dist/programmes-seo/index.js",
+			"types": "./dist/programmes-seo/index.d.ts"
+		},
+		"./scholarships-search-seo": {
+			"import": "./dist/scholarships-seo/index.js",
+			"require": "./dist/scholarships-seo/index.js",
+			"types": "./dist/scholarships-seo/index.d.ts"
+		},
+		"./sitemap-generator-seo": {
+			"import": "./dist/sitemap-generator-seo/index.js",
+			"require": "./dist/sitemap-generator-seo/index.js",
+			"types": "./dist/sitemap-generator-seo/index.d.ts"
+		},
+		"./structured-data-seo": {
+			"import": "./dist/structured-data-seo/index.js",
+			"require": "./dist/structured-data-seo/index.js",
+			"types": "./dist/structured-data-seo/index.d.ts"
+		}
+	},
+	"typesVersions": {
+		"*": {
+			"organisations-search-seo": [
+				"dist/organisations-seo/index.d.ts"
+			],
+			"programmes-search-seo": [
+				"dist/programmes-seo/index.d.ts"
+			],
+			"scholarships-search-seo": [
+				"dist/scholarships-seo/index.d.ts"
+			],
+			"sitemap-generator-seo": [
+				"dist/sitemap-generator-seo/index.d.ts"
+			],
+			"structured-data-seo": [
+				"dist/structured-data-seo/index.d.ts"
+			],
+			"*": [
+				"dist/index.d.ts"
+			]
+		}
+	},
+	"author": "The Jedi Council",
+	"license": "ISC",
+	"devDependencies": {
+		"@adobe/structured-data-validator": "^1.4.1",
+		"@studyportals/code-style": "^2.2.1",
+		"@studyportals/webpack-helper": "^6.0.6",
+		"@vitest/coverage-istanbul": "^2.1.8",
+		"husky": "^8.0.3",
+		"jsdom": "^26.0.0",
+		"prettier": "^3.5.3",
+		"schema-dts": "^1.1.5",
+		"ts-loader": "^9.5.2",
+		"tsc-alias": "^1.8.11",
+		"typemoq": "^2.1.0",
+		"typescript": "^5.7.3",
+		"vitest": "^2.1.8"
+	},
+	"dependencies": {
+		"@studyportals/domain-client": "7.1.0",
+		"@studyportals/ranking-api-interface": "^1.3.12",
+		"@studyportals/search-filters": "^6.1.0",
+		"@studyportals/static-domain-data": "^6.1.0"
+	},
+	"optionalDependencies": {
+		"@rollup/rollup-linux-x64-gnu": "4.24.0"
+	},
+	"engines": {
+		"node": ">=18 <=22",
+		"npm": ">=8 <=10"
+	}
+}

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

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

package/dist/src/common/IPolicyMetaData.js

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

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

@@ -1,10 +0,0 @@
-import { ISearchDependencies } from '../../common/ISearchDependencies';
-import { FilterKeyValuesMap } from '../../common/FilterKeyValuesMap';
-import { BaseProgrammeRule } from '../BaseProgrammeRule';
-export declare class DegreeAttendanceSpecificRule extends BaseProgrammeRule {
-    private readonly validCombinations;
-    getName(): string;
-    getDescription(): string;
-    forSearch(dependencies: ISearchDependencies): Promise<boolean>;
-    forSitemapGenerator(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
-}

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

@@ -1,42 +0,0 @@
-import { FilterKey } from '@studyportals/search-filters';
-import { BaseProgrammeRule } from '../BaseProgrammeRule';
-export class DegreeAttendanceSpecificRule extends BaseProgrammeRule {
-    validCombinations = {
-        'master-of-science': ['online'], // MSc with online attendance
-        'master-of-arts': ['online'], // MA with online attendance
-        'master-of-business-administration': ['online'] // MBA with online attendance
-    };
-    getName() {
-        return 'DegreeAttendanceSpecificRule';
-    }
-    getDescription() {
-        return 'Indexes: master-of-science (online); master-of-arts (online); master-of-business-administration (online)';
-    }
-    forSearch(dependencies) {
-        const { seoInfoBase, filterState } = dependencies;
-        const degreeTypeValue = seoInfoBase.getFilterOptionValueBy(FilterKey.DEGREE_TYPE, filterState);
-        const attendanceValue = seoInfoBase.getFilterOptionValueBy(FilterKey.DELIVERY_METHOD, filterState);
-        if (!degreeTypeValue || !attendanceValue) {
-            return Promise.resolve(false);
-        }
-        const allowedAttendance = this.validCombinations[degreeTypeValue];
-        if (!allowedAttendance) {
-            return Promise.resolve(false);
-        }
-        return Promise.resolve(allowedAttendance.includes(attendanceValue));
-    }
-    forSitemapGenerator(filterKeyValues) {
-        const degreeTypeValues = filterKeyValues.get(FilterKey.DEGREE_TYPE);
-        const attendanceValues = filterKeyValues.get(FilterKey.DELIVERY_METHOD);
-        if (!degreeTypeValues?.length || !attendanceValues?.length) {
-            return Promise.resolve(false);
-        }
-        const degreeTypeValue = degreeTypeValues[0];
-        const attendanceValue = attendanceValues[0];
-        const allowedAttendance = this.validCombinations[degreeTypeValue];
-        if (!allowedAttendance) {
-            return Promise.resolve(false);
-        }
-        return Promise.resolve(allowedAttendance.includes(attendanceValue));
-    }
-}

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

@@ -1,10 +0,0 @@
-import { ISearchDependencies } from '../../common/ISearchDependencies';
-import { FilterKeyValuesMap } from '../../common/FilterKeyValuesMap';
-import { BaseProgrammeRule } from '../BaseProgrammeRule';
-export declare class MasterOfArtsDisciplineRule extends BaseProgrammeRule {
-    private readonly degreeValue;
-    getName(): string;
-    getDescription(): string;
-    forSearch(dependencies: ISearchDependencies): Promise<boolean>;
-    forSitemapGenerator(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
-}

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

@@ -1,41 +0,0 @@
-import { FilterKey } from '@studyportals/search-filters';
-import { BaseProgrammeRule } from '../BaseProgrammeRule';
-export class MasterOfArtsDisciplineRule extends BaseProgrammeRule {
-    // Master of Arts accepts all disciplines
-    degreeValue = 'master-of-arts';
-    getName() {
-        return 'MasterOfArtsDisciplineRule';
-    }
-    getDescription() {
-        return 'Indexes: master-of-arts + all disciplines';
-    }
-    forSearch(dependencies) {
-        const { seoInfoBase, filterState } = dependencies;
-        const degreeTypeValue = seoInfoBase.getFilterOptionValueBy(FilterKey.DEGREE_TYPE, filterState);
-        const disciplineValue = seoInfoBase.getFilterOptionValueBy(FilterKey.DISCIPLINES, filterState);
-        // This rule only applies to Master of Arts
-        if (degreeTypeValue !== this.degreeValue) {
-            return Promise.resolve(true); // Rule doesn't apply to other degrees
-        }
-        // Must have a discipline selected
-        if (!disciplineValue) {
-            return Promise.resolve(false);
-        }
-        // Master of Arts accepts all disciplines
-        return Promise.resolve(true);
-    }
-    forSitemapGenerator(filterKeyValues) {
-        const degreeTypeValues = filterKeyValues.get(FilterKey.DEGREE_TYPE);
-        const disciplineValues = filterKeyValues.get(FilterKey.DISCIPLINES);
-        if (!degreeTypeValues?.length || !disciplineValues?.length) {
-            return Promise.resolve(false);
-        }
-        const degreeTypeValue = degreeTypeValues[0];
-        // This rule only applies to Master of Arts
-        if (degreeTypeValue !== this.degreeValue) {
-            return Promise.resolve(true); // Rule doesn't apply to other degrees
-        }
-        // Master of Arts accepts all disciplines
-        return Promise.resolve(true);
-    }
-}

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

@@ -1,10 +0,0 @@
-import { ISearchDependencies } from '../../common/ISearchDependencies';
-import { FilterKeyValuesMap } from '../../common/FilterKeyValuesMap';
-import { BaseProgrammeRule } from '../BaseProgrammeRule';
-export declare class MasterOfScienceDisciplineRule extends BaseProgrammeRule {
-    private readonly degreeValue;
-    getName(): string;
-    getDescription(): string;
-    forSearch(dependencies: ISearchDependencies): Promise<boolean>;
-    forSitemapGenerator(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
-}

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

@@ -1,41 +0,0 @@
-import { FilterKey } from '@studyportals/search-filters';
-import { BaseProgrammeRule } from '../BaseProgrammeRule';
-export class MasterOfScienceDisciplineRule extends BaseProgrammeRule {
-    // Master of Science accepts all disciplines
-    degreeValue = 'master-of-science';
-    getName() {
-        return 'MasterOfScienceDisciplineRule';
-    }
-    getDescription() {
-        return 'Indexes: master-of-science + all disciplines';
-    }
-    forSearch(dependencies) {
-        const { seoInfoBase, filterState } = dependencies;
-        const degreeTypeValue = seoInfoBase.getFilterOptionValueBy(FilterKey.DEGREE_TYPE, filterState);
-        const disciplineValue = seoInfoBase.getFilterOptionValueBy(FilterKey.DISCIPLINES, filterState);
-        // This rule only applies to Master of Science
-        if (degreeTypeValue !== this.degreeValue) {
-            return Promise.resolve(true); // Rule doesn't apply to other degrees
-        }
-        // Must have a discipline selected
-        if (!disciplineValue) {
-            return Promise.resolve(false);
-        }
-        // Master of Science accepts all disciplines
-        return Promise.resolve(true);
-    }
-    forSitemapGenerator(filterKeyValues) {
-        const degreeTypeValues = filterKeyValues.get(FilterKey.DEGREE_TYPE);
-        const disciplineValues = filterKeyValues.get(FilterKey.DISCIPLINES);
-        if (!degreeTypeValues?.length || !disciplineValues?.length) {
-            return Promise.resolve(false);
-        }
-        const degreeTypeValue = degreeTypeValues[0];
-        // This rule only applies to Master of Science
-        if (degreeTypeValue !== this.degreeValue) {
-            return Promise.resolve(true); // Rule doesn't apply to other degrees
-        }
-        // Master of Science accepts all disciplines
-        return Promise.resolve(true);
-    }
-}

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

@@ -1,3 +0,0 @@
-export interface IPageNumberProvider {
-    getPageNumber(): number;
-}

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

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