@studyportals/fawkes 8.0.2-0 → 8.1.1-0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (127) hide show
  1. package/dist/src/enums/FilterCombinations.d.ts +1 -23
  2. package/dist/src/enums/FilterCombinations.js +1 -23
  3. package/dist/src/organisations/rules/AtLeastSevenResultsRule.d.ts +15 -0
  4. package/dist/src/organisations/rules/AtLeastSevenResultsRule.js +30 -0
  5. package/dist/src/presenters/AttendancePresenter.js +0 -4
  6. package/dist/src/presenters/FormatPresenter.js +1 -4
  7. package/dist/src/presenters/SpecialProgrammesPresenter.js +0 -4
  8. package/dist/src/programmes/ProgrammesBaseIndexabilityPolicy.js +0 -1
  9. package/dist/src/programmes/SearchIndexabilityManager.js +3 -27
  10. package/dist/src/programmes/policies/AttendanceDegree.d.ts +3 -2
  11. package/dist/src/programmes/policies/AttendanceDegree.js +6 -7
  12. package/dist/src/programmes/policies/CountryAttendanceDegree.js +1 -1
  13. package/dist/src/programmes/policies/CountryDuration.d.ts +2 -2
  14. package/dist/src/programmes/policies/CountryDuration.js +4 -6
  15. package/dist/src/programmes/policies/CountryDurationDegree.js +1 -1
  16. package/dist/src/programmes/policies/CountryEducationalForm.js +1 -1
  17. package/dist/src/programmes/policies/DegreeAttendanceDiscipline.d.ts +1 -2
  18. package/dist/src/programmes/policies/DegreeAttendanceDiscipline.js +12 -12
  19. package/dist/src/programmes/policies/DisciplineArea.d.ts +1 -1
  20. package/dist/src/programmes/policies/DisciplineArea.js +1 -1
  21. package/dist/src/programmes/policies/DisciplineCountryEducationalForm.js +1 -1
  22. package/dist/src/programmes/policies/DisciplineEducationalForm.js +1 -1
  23. package/dist/src/programmes/policies/SpecialProgrammes.d.ts +2 -1
  24. package/dist/src/programmes/policies/SpecialProgrammes.js +3 -1
  25. package/dist/src/programmes/policies/index.d.ts +1 -26
  26. package/dist/src/programmes/policies/index.js +1 -26
  27. package/dist/src/programmes/rules/AtLeastSevenResultsRule.js +1 -1
  28. package/dist/src/programmes/rules/ErasmusOrJointSpecialProgrammesRule.js +2 -2
  29. package/dist/src/sitemap-generator/ProgrammesSitemapUrlGeneratorManager.js +3 -27
  30. package/dist/src/structured-data/OrganisationStructuredDataFactory.d.ts +9 -0
  31. package/dist/src/structured-data/OrganisationStructuredDataFactory.js +25 -0
  32. package/dist/src/structured-data/dto/OrganisationDTO.d.ts +7 -0
  33. package/package.json +105 -105
  34. package/dist/src/common/IPolicyMetaData.d.ts +0 -6
  35. package/dist/src/organisations/OrganisationsRuleBasedIndexabilityPolicy.d.ts +0 -11
  36. package/dist/src/organisations/OrganisationsRuleBasedIndexabilityPolicy.js +0 -19
  37. package/dist/src/organisations/rules/OnlineAttendanceRule.d.ts +0 -6
  38. package/dist/src/organisations/rules/OnlineAttendanceRule.js +0 -14
  39. package/dist/src/programmes/IProgrammeSearchApplicationState.d.ts +0 -4
  40. package/dist/src/programmes/IProgrammeSearchApplicationState.js +0 -1
  41. package/dist/src/programmes/IProgrammeSearchDependencies.d.ts +0 -7
  42. package/dist/src/programmes/IProgrammeSearchDependencies.js +0 -1
  43. package/dist/src/programmes/IProgrammesSeoDependencies.d.ts +0 -2
  44. package/dist/src/programmes/IProgrammesSeoDependencies.js +0 -1
  45. package/dist/src/programmes/policies/AttendanceArea.d.ts +0 -16
  46. package/dist/src/programmes/policies/AttendanceArea.js +0 -48
  47. package/dist/src/programmes/policies/AttendanceContinent.d.ts +0 -16
  48. package/dist/src/programmes/policies/AttendanceContinent.js +0 -46
  49. package/dist/src/programmes/policies/AttendanceDuration.d.ts +0 -16
  50. package/dist/src/programmes/policies/AttendanceDuration.js +0 -48
  51. package/dist/src/programmes/policies/AttendanceFormat.d.ts +0 -16
  52. package/dist/src/programmes/policies/AttendanceFormat.js +0 -48
  53. package/dist/src/programmes/policies/AttendanceTuitionFee.d.ts +0 -16
  54. package/dist/src/programmes/policies/AttendanceTuitionFee.js +0 -49
  55. package/dist/src/programmes/policies/ContinentDuration.d.ts +0 -15
  56. package/dist/src/programmes/policies/ContinentDuration.js +0 -46
  57. package/dist/src/programmes/policies/ContinentFormat.d.ts +0 -15
  58. package/dist/src/programmes/policies/ContinentFormat.js +0 -46
  59. package/dist/src/programmes/policies/ContinentSpecialProgrammes.d.ts +0 -15
  60. package/dist/src/programmes/policies/ContinentSpecialProgrammes.js +0 -46
  61. package/dist/src/programmes/policies/CountrySpecialProgrammes.d.ts +0 -15
  62. package/dist/src/programmes/policies/CountrySpecialProgrammes.js +0 -46
  63. package/dist/src/programmes/policies/DegreeArea.d.ts +0 -15
  64. package/dist/src/programmes/policies/DegreeArea.js +0 -46
  65. package/dist/src/programmes/policies/DegreeAreaTuitionFee.d.ts +0 -15
  66. package/dist/src/programmes/policies/DegreeAreaTuitionFee.js +0 -52
  67. package/dist/src/programmes/policies/DegreeAttendanceFormat.d.ts +0 -15
  68. package/dist/src/programmes/policies/DegreeAttendanceFormat.js +0 -52
  69. package/dist/src/programmes/policies/DegreeAttendanceSpecialProgrammes.d.ts +0 -16
  70. package/dist/src/programmes/policies/DegreeAttendanceSpecialProgrammes.js +0 -56
  71. package/dist/src/programmes/policies/DegreeAttendanceTuitionFee.d.ts +0 -16
  72. package/dist/src/programmes/policies/DegreeAttendanceTuitionFee.js +0 -55
  73. package/dist/src/programmes/policies/DegreeContinent.d.ts +0 -16
  74. package/dist/src/programmes/policies/DegreeContinent.js +0 -46
  75. package/dist/src/programmes/policies/DegreeContinentTuitionFee.d.ts +0 -16
  76. package/dist/src/programmes/policies/DegreeContinentTuitionFee.js +0 -52
  77. package/dist/src/programmes/policies/DegreeDuration.d.ts +0 -16
  78. package/dist/src/programmes/policies/DegreeDuration.js +0 -48
  79. package/dist/src/programmes/policies/DegreeFormat.d.ts +0 -16
  80. package/dist/src/programmes/policies/DegreeFormat.js +0 -49
  81. package/dist/src/programmes/policies/DegreeFormatTuitionFee.d.ts +0 -16
  82. package/dist/src/programmes/policies/DegreeFormatTuitionFee.js +0 -52
  83. package/dist/src/programmes/policies/DegreeSpecialProgrammes.d.ts +0 -15
  84. package/dist/src/programmes/policies/DegreeSpecialProgrammes.js +0 -48
  85. package/dist/src/programmes/policies/DegreeTuitionFee.d.ts +0 -15
  86. package/dist/src/programmes/policies/DegreeTuitionFee.js +0 -47
  87. package/dist/src/programmes/policies/DisciplineContinentAttendance.d.ts +0 -16
  88. package/dist/src/programmes/policies/DisciplineContinentAttendance.js +0 -54
  89. package/dist/src/programmes/policies/DisciplineCountryAttendance.d.ts +0 -16
  90. package/dist/src/programmes/policies/DisciplineCountryAttendance.js +0 -54
  91. package/dist/src/programmes/policies/DisciplineCountryDegree.d.ts +0 -16
  92. package/dist/src/programmes/policies/DisciplineCountryDegree.js +0 -53
  93. package/dist/src/programmes/policies/DisciplineCountryFormat.d.ts +0 -15
  94. package/dist/src/programmes/policies/DisciplineCountryFormat.js +0 -52
  95. package/dist/src/programmes/policies/DisciplineSpecialProgrammes.d.ts +0 -15
  96. package/dist/src/programmes/policies/DisciplineSpecialProgrammes.js +0 -46
  97. package/dist/src/programmes/policies/Duration.d.ts +0 -15
  98. package/dist/src/programmes/policies/Duration.js +0 -38
  99. package/dist/src/programmes/policies/Format.d.ts +0 -15
  100. package/dist/src/programmes/policies/Format.js +0 -38
  101. package/dist/src/programmes/rules/DegreeAttendanceSpecificRule.d.ts +0 -10
  102. package/dist/src/programmes/rules/DegreeAttendanceSpecificRule.js +0 -42
  103. package/dist/src/programmes/rules/DegreeCountrySpecificRule.d.ts +0 -10
  104. package/dist/src/programmes/rules/DegreeCountrySpecificRule.js +0 -43
  105. package/dist/src/programmes/rules/DegreeCountryTuitionFeeRule.d.ts +0 -11
  106. package/dist/src/programmes/rules/DegreeCountryTuitionFeeRule.js +0 -40
  107. package/dist/src/programmes/rules/MBACountryAttendanceRule.d.ts +0 -11
  108. package/dist/src/programmes/rules/MBACountryAttendanceRule.js +0 -40
  109. package/dist/src/programmes/rules/MasterOfArtsDisciplineRule.d.ts +0 -10
  110. package/dist/src/programmes/rules/MasterOfArtsDisciplineRule.js +0 -41
  111. package/dist/src/programmes/rules/MasterOfEducationCountryDisciplineRule.d.ts +0 -11
  112. package/dist/src/programmes/rules/MasterOfEducationCountryDisciplineRule.js +0 -69
  113. package/dist/src/programmes/rules/MasterOfLawsCountryAttendanceRule.d.ts +0 -12
  114. package/dist/src/programmes/rules/MasterOfLawsCountryAttendanceRule.js +0 -43
  115. package/dist/src/programmes/rules/MasterOfLawsCountryTuitionFeeRule.d.ts +0 -12
  116. package/dist/src/programmes/rules/MasterOfLawsCountryTuitionFeeRule.js +0 -46
  117. package/dist/src/programmes/rules/MasterOfPhilosophyCountryAttendanceRule.d.ts +0 -12
  118. package/dist/src/programmes/rules/MasterOfPhilosophyCountryAttendanceRule.js +0 -43
  119. package/dist/src/programmes/rules/MasterOfScienceDisciplineRule.d.ts +0 -10
  120. package/dist/src/programmes/rules/MasterOfScienceDisciplineRule.js +0 -41
  121. package/dist/src/programmes/rules/OneYearOnlyRule.d.ts +0 -11
  122. package/dist/src/programmes/rules/OneYearOnlyRule.js +0 -34
  123. package/dist/src/programmes/rules/OnlineAttendanceRule.d.ts +0 -6
  124. package/dist/src/programmes/rules/OnlineAttendanceRule.js +0 -15
  125. package/dist/src/sitemap-generator/IPageNumberProvider.d.ts +0 -3
  126. package/dist/src/sitemap-generator/IPageNumberProvider.js +0 -1
  127. /package/dist/src/{common/IPolicyMetaData.js → structured-data/dto/OrganisationDTO.js} +0 -0
@@ -1,5 +1,5 @@
1
- import { FilterKey } from '@studyportals/search-filters';
2
- import { SpecialProgrammesFilterOptionValue } from '@studyportals/search-filters';
1
+ import { FilterKey } from '@studyportals/search-filters/server-side';
2
+ import { SpecialProgrammesFilterOptionValue } from '@studyportals/search-filters/server-side';
3
3
  import { BaseProgrammeRule } from '../BaseProgrammeRule';
4
4
  export class ErasmusOrJointSpecialProgrammesRule extends BaseProgrammeRule {
5
5
  forSearch(dependencies) {
@@ -1,6 +1,6 @@
1
1
  import { DependencyTypes } from '../enums/DependencyTypes';
2
2
  import { BaseSitemapUrlGeneratorManager } from './BaseSitemapUrlGeneratorManager';
3
- import { Area, Attendance, AttendanceDegree, Continent, ContinentTuitionFee, Country, CountryAttendance, Discipline, SpecialProgrammes, TuitionFee, Unfiltered, CountryAttendanceDegree, CountryDuration, CountryDurationDegree, CountryEducationalForm, CountryFormat, CountryTuitionFee, DegreeAttendanceDiscipline, DegreeCountryAttendance, DegreeCountryDiscipline, DegreeCountryTuitionFee, Format, DisciplineAttendance, DisciplineContinent, DisciplineCountry, DisciplineCountryEducationalForm, DisciplineDegree, DisciplineDuration, DisciplineEducationalForm, DisciplineFormat, DisciplineTuitionFee, DisciplineTuitionFeeAttendance, CountryDegree, DegreeFormat, DegreeContinent, DegreeAttendanceTuitionFee, DegreeArea, DegreeTuitionFee, AttendanceTuitionFee, Duration, AttendanceDuration, DegreeAreaTuitionFee, DisciplineContinentAttendance, DegreeContinentTuitionFee, AttendanceFormat, ContinentFormat, AttendanceContinent, DegreeDuration, ContinentSpecialProgrammes, CountrySpecialProgrammes, AttendanceArea, DegreeFormatTuitionFee, ContinentDuration, DegreeAttendanceFormat, DisciplineCountryAttendance, DisciplineCountryFormat, DegreeSpecialProgrammes } from '../programmes/policies';
3
+ import { Area, Attendance, AttendanceDegree, Continent, ContinentTuitionFee, Country, CountryAttendance, Discipline, SpecialProgrammes, TuitionFee, Unfiltered, CountryAttendanceDegree, CountryDuration, CountryDurationDegree, CountryEducationalForm, CountryFormat, CountryTuitionFee, DegreeAttendanceDiscipline, DegreeCountryAttendance, DegreeCountryDiscipline, DegreeCountryTuitionFee, DisciplineArea, DisciplineAttendance, DisciplineContinent, DisciplineCountry, DisciplineCountryEducationalForm, DisciplineDegree, DisciplineDuration, DisciplineEducationalForm, DisciplineFormat, DisciplineTuitionFee, DisciplineTuitionFeeAttendance, CountryDegree } from '../programmes/policies';
4
4
  import { FilterKey } from '@studyportals/search-filters/server-side';
5
5
  import { AreaPresenter } from '../presenters/AreaPresenter';
6
6
  import { AttendancePresenter } from '../presenters/AttendancePresenter';
@@ -30,8 +30,6 @@ export class ProgrammesSitemapUrlGeneratorManager extends BaseSitemapUrlGenerato
30
30
  new Area(dependencies),
31
31
  new Attendance(dependencies),
32
32
  new AttendanceDegree(dependencies),
33
- new AttendanceDuration(dependencies),
34
- new AttendanceContinent(dependencies),
35
33
  new Continent(dependencies),
36
34
  new ContinentTuitionFee(dependencies),
37
35
  new Country(dependencies),
@@ -41,7 +39,6 @@ export class ProgrammesSitemapUrlGeneratorManager extends BaseSitemapUrlGenerato
41
39
  new SpecialProgrammes(dependencies),
42
40
  new TuitionFee(dependencies),
43
41
  new Unfiltered(dependencies),
44
- new Duration(dependencies),
45
42
  new CountryAttendanceDegree(dependencies),
46
43
  new CountryDegree(dependencies),
47
44
  new CountryDuration(dependencies),
@@ -49,26 +46,11 @@ export class ProgrammesSitemapUrlGeneratorManager extends BaseSitemapUrlGenerato
49
46
  new CountryEducationalForm(dependencies),
50
47
  new CountryFormat(dependencies),
51
48
  new CountryTuitionFee(dependencies),
52
- new CountrySpecialProgrammes(dependencies),
53
- new ContinentFormat(dependencies),
54
- new ContinentSpecialProgrammes(dependencies),
55
- new ContinentDuration(dependencies),
56
49
  new DegreeAttendanceDiscipline(dependencies),
57
50
  new DegreeCountryAttendance(dependencies),
58
51
  new DegreeCountryDiscipline(dependencies),
59
52
  new DegreeCountryTuitionFee(dependencies),
60
- new DegreeFormat(dependencies),
61
- new DegreeContinent(dependencies),
62
- new DegreeAttendanceTuitionFee(dependencies),
63
- new DegreeArea(dependencies),
64
- new DegreeTuitionFee(dependencies),
65
- new DegreeAreaTuitionFee(dependencies),
66
- new DegreeContinentTuitionFee(dependencies),
67
- new DegreeDuration(dependencies),
68
- new DegreeFormatTuitionFee(dependencies),
69
- new DegreeAttendanceFormat(dependencies),
70
- new DegreeSpecialProgrammes(dependencies),
71
- new Format(dependencies),
53
+ new DisciplineArea(dependencies),
72
54
  new DisciplineAttendance(dependencies),
73
55
  new DisciplineContinent(dependencies),
74
56
  new DisciplineCountry(dependencies),
@@ -78,13 +60,7 @@ export class ProgrammesSitemapUrlGeneratorManager extends BaseSitemapUrlGenerato
78
60
  new DisciplineEducationalForm(dependencies),
79
61
  new DisciplineFormat(dependencies),
80
62
  new DisciplineTuitionFee(dependencies),
81
- new DisciplineTuitionFeeAttendance(dependencies),
82
- new DisciplineContinentAttendance(dependencies),
83
- new DisciplineCountryAttendance(dependencies),
84
- new DisciplineCountryFormat(dependencies),
85
- new AttendanceTuitionFee(dependencies),
86
- new AttendanceFormat(dependencies),
87
- new AttendanceArea(dependencies)
63
+ new DisciplineTuitionFeeAttendance(dependencies)
88
64
  ];
89
65
  this.presenters.set(FilterKey.AREA, AreaPresenter.getInstance());
90
66
  this.presenters.set(FilterKey.DELIVERY_METHOD, AttendancePresenter.getInstance());
@@ -0,0 +1,9 @@
1
+ import { SearchStructuredDataFactory } from "./SearchStructuredDataFactory";
2
+ import { ReviewRatingDTO } from "./dto/ReviewRatingDTO";
3
+ import { Course } from "schema-dts";
4
+ import { EntityDTO } from "./dto/EntityDTO";
5
+ import { OrganisationDTO } from '../structured-data/dto/OrganisationDTO';
6
+ export declare class OrganisationStructuredDataFactory extends SearchStructuredDataFactory<OrganisationDTO> {
7
+ protected getRating(card: OrganisationDTO): ReviewRatingDTO | undefined;
8
+ protected buildStructuredDataForCard(entity: EntityDTO<OrganisationDTO>): Course | undefined;
9
+ }
@@ -0,0 +1,25 @@
1
+ import { SearchStructuredDataFactory } from "./SearchStructuredDataFactory";
2
+ export class OrganisationStructuredDataFactory extends SearchStructuredDataFactory {
3
+ getRating(card) {
4
+ const rating = card.reviewRating;
5
+ if (!rating || !rating.hasEnoughQuantity())
6
+ return;
7
+ return {
8
+ rating: rating?.getAverageStarRating(),
9
+ quantity: rating?.getQuantity(),
10
+ };
11
+ }
12
+ buildStructuredDataForCard(entity) {
13
+ const offer = this.constructOffer(entity.offer);
14
+ if (!offer)
15
+ return undefined;
16
+ const card = entity.card;
17
+ return {
18
+ "@type": "Course",
19
+ "name": card.name,
20
+ "description": card.description,
21
+ "url": card.url,
22
+ "aggregateRating": this.constructAggregateRating(entity.reviewRating),
23
+ };
24
+ }
25
+ }
@@ -0,0 +1,7 @@
1
+ import { IReviewRating } from '@studyportals/domain-client';
2
+ export interface OrganisationDTO {
3
+ name: string;
4
+ url: string;
5
+ description?: string;
6
+ reviewRating?: IReviewRating;
7
+ }
package/package.json CHANGED
@@ -1,105 +1,105 @@
1
- {
2
- "name": "@studyportals/fawkes",
3
- "version": "8.0.2-0",
4
- "description": "A package to centralize SEO related logic for SBLP and Sitemap Generator.",
5
- "files": [
6
- "./dist"
7
- ],
8
- "scripts": {
9
- "prepush": "npm run test",
10
- "precommit": "npm run lint",
11
- "compile": "npx tsc && tsc-alias && rm -r ./dist/tests",
12
- "build": "npm run clean && npm run compile",
13
- "clean": "rimraf \"!(node_modules)/**/dist\"",
14
- "prepare-deployment": "npm run test && npm run build",
15
- "publish-major": "npm run prepare-deployment && npm version major && npm publish",
16
- "publish-beta": "npm run prepare-deployment && npm version prerelease && npm publish --tag beta --access=public",
17
- "publish-patch": "npm run prepare-deployment && npm version patch && npm publish",
18
- "publish-minor": "npm run prepare-deployment && npm version minor && npm publish",
19
- "prepare": "husky install",
20
- "test": "vitest run --coverage",
21
- "test:dev": "vitest --coverage tests/programmes",
22
- "lint": "eslint . --ext .ts",
23
- "lint:fix": "eslint . --ext .ts --fix",
24
- "prettier:fix": "npx prettier --use-tabs --ignore-path .gitignore --write ."
25
- },
26
- "exports": {
27
- "./organisations-search-seo": {
28
- "import": "./dist/organisations-seo/index.js",
29
- "require": "./dist/organisations-seo/index.js",
30
- "types": "./dist/organisations-seo/index.d.ts"
31
- },
32
- "./programmes-search-seo": {
33
- "import": "./dist/programmes-seo/index.js",
34
- "require": "./dist/programmes-seo/index.js",
35
- "types": "./dist/programmes-seo/index.d.ts"
36
- },
37
- "./scholarships-search-seo": {
38
- "import": "./dist/scholarships-seo/index.js",
39
- "require": "./dist/scholarships-seo/index.js",
40
- "types": "./dist/scholarships-seo/index.d.ts"
41
- },
42
- "./sitemap-generator-seo": {
43
- "import": "./dist/sitemap-generator-seo/index.js",
44
- "require": "./dist/sitemap-generator-seo/index.js",
45
- "types": "./dist/sitemap-generator-seo/index.d.ts"
46
- },
47
- "./structured-data-seo": {
48
- "import": "./dist/structured-data-seo/index.js",
49
- "require": "./dist/structured-data-seo/index.js",
50
- "types": "./dist/structured-data-seo/index.d.ts"
51
- }
52
- },
53
- "typesVersions": {
54
- "*": {
55
- "organisations-search-seo": [
56
- "dist/organisations-seo/index.d.ts"
57
- ],
58
- "programmes-search-seo": [
59
- "dist/programmes-seo/index.d.ts"
60
- ],
61
- "scholarships-search-seo": [
62
- "dist/scholarships-seo/index.d.ts"
63
- ],
64
- "sitemap-generator-seo": [
65
- "dist/sitemap-generator-seo/index.d.ts"
66
- ],
67
- "structured-data-seo": [
68
- "dist/structured-data-seo/index.d.ts"
69
- ],
70
- "*": [
71
- "dist/index.d.ts"
72
- ]
73
- }
74
- },
75
- "author": "The Jedi Council",
76
- "license": "ISC",
77
- "devDependencies": {
78
- "@adobe/structured-data-validator": "^1.4.1",
79
- "@studyportals/code-style": "^2.2.1",
80
- "@studyportals/webpack-helper": "^6.0.6",
81
- "@vitest/coverage-istanbul": "^2.1.8",
82
- "husky": "^8.0.3",
83
- "jsdom": "^26.0.0",
84
- "prettier": "^3.5.3",
85
- "schema-dts": "^1.1.5",
86
- "ts-loader": "^9.5.2",
87
- "tsc-alias": "^1.8.11",
88
- "typemoq": "^2.1.0",
89
- "typescript": "^5.7.3",
90
- "vitest": "^2.1.8"
91
- },
92
- "dependencies": {
93
- "@studyportals/domain-client": "7.1.0",
94
- "@studyportals/ranking-api-interface": "^1.3.12",
95
- "@studyportals/search-filters": "^6.1.0",
96
- "@studyportals/static-domain-data": "^6.1.0"
97
- },
98
- "optionalDependencies": {
99
- "@rollup/rollup-linux-x64-gnu": "4.24.0"
100
- },
101
- "engines": {
102
- "node": ">=18 <=22",
103
- "npm": ">=8 <=10"
104
- }
105
- }
1
+ {
2
+ "name": "@studyportals/fawkes",
3
+ "version": "8.1.1-0",
4
+ "description": "A package to centralize SEO related logic for SBLP and Sitemap Generator.",
5
+ "files": [
6
+ "./dist"
7
+ ],
8
+ "scripts": {
9
+ "prepush": "npm run test",
10
+ "precommit": "npm run lint",
11
+ "compile": "npx tsc && tsc-alias && rm -r ./dist/tests",
12
+ "build": "npm run clean && npm run compile",
13
+ "clean": "rimraf \"!(node_modules)/**/dist\"",
14
+ "prepare-deployment": "npm run test && npm run build",
15
+ "publish-major": "npm run prepare-deployment && npm version major && npm publish",
16
+ "publish-beta": "npm run prepare-deployment && npm version prerelease && npm publish --tag beta --access=public",
17
+ "publish-patch": "npm run prepare-deployment && npm version patch && npm publish",
18
+ "publish-minor": "npm run prepare-deployment && npm version minor && npm publish",
19
+ "prepare": "husky install",
20
+ "test": "vitest run --coverage",
21
+ "test:dev": "vitest --coverage tests/programmes",
22
+ "lint": "eslint . --ext .ts",
23
+ "lint:fix": "eslint . --ext .ts --fix",
24
+ "prettier:fix": "npx prettier --use-tabs --ignore-path .gitignore --write ."
25
+ },
26
+ "exports": {
27
+ "./organisations-search-seo": {
28
+ "import": "./dist/organisations-seo/index.js",
29
+ "require": "./dist/organisations-seo/index.js",
30
+ "types": "./dist/organisations-seo/index.d.ts"
31
+ },
32
+ "./programmes-search-seo": {
33
+ "import": "./dist/programmes-seo/index.js",
34
+ "require": "./dist/programmes-seo/index.js",
35
+ "types": "./dist/programmes-seo/index.d.ts"
36
+ },
37
+ "./scholarships-search-seo": {
38
+ "import": "./dist/scholarships-seo/index.js",
39
+ "require": "./dist/scholarships-seo/index.js",
40
+ "types": "./dist/scholarships-seo/index.d.ts"
41
+ },
42
+ "./sitemap-generator-seo": {
43
+ "import": "./dist/sitemap-generator-seo/index.js",
44
+ "require": "./dist/sitemap-generator-seo/index.js",
45
+ "types": "./dist/sitemap-generator-seo/index.d.ts"
46
+ },
47
+ "./structured-data-seo": {
48
+ "import": "./dist/structured-data-seo/index.js",
49
+ "require": "./dist/structured-data-seo/index.js",
50
+ "types": "./dist/structured-data-seo/index.d.ts"
51
+ }
52
+ },
53
+ "typesVersions": {
54
+ "*": {
55
+ "organisations-search-seo": [
56
+ "dist/organisations-seo/index.d.ts"
57
+ ],
58
+ "programmes-search-seo": [
59
+ "dist/programmes-seo/index.d.ts"
60
+ ],
61
+ "scholarships-search-seo": [
62
+ "dist/scholarships-seo/index.d.ts"
63
+ ],
64
+ "sitemap-generator-seo": [
65
+ "dist/sitemap-generator-seo/index.d.ts"
66
+ ],
67
+ "structured-data-seo": [
68
+ "dist/structured-data-seo/index.d.ts"
69
+ ],
70
+ "*": [
71
+ "dist/index.d.ts"
72
+ ]
73
+ }
74
+ },
75
+ "author": "The Jedi Council",
76
+ "license": "ISC",
77
+ "devDependencies": {
78
+ "@adobe/structured-data-validator": "^1.4.1",
79
+ "@studyportals/code-style": "^2.2.1",
80
+ "@studyportals/webpack-helper": "^6.0.6",
81
+ "@vitest/coverage-istanbul": "^2.1.8",
82
+ "husky": "^8.0.3",
83
+ "jsdom": "^26.0.0",
84
+ "prettier": "^3.5.3",
85
+ "tsc-alias": "^1.8.11",
86
+ "typemoq": "^2.1.0",
87
+ "typescript": "^5.7.3",
88
+ "vitest": "^2.1.8",
89
+ "schema-dts": "^1.1.5",
90
+ "ts-loader": "^9.5.2"
91
+ },
92
+ "dependencies": {
93
+ "@studyportals/domain-client": "^6.3.0",
94
+ "@studyportals/ranking-api-interface": "^1.3.12",
95
+ "@studyportals/search-filters": "^6.1.0",
96
+ "@studyportals/static-domain-data": "^6.1.0"
97
+ },
98
+ "optionalDependencies": {
99
+ "@rollup/rollup-linux-x64-gnu": "4.24.0"
100
+ },
101
+ "engines": {
102
+ "node": ">=18 <=22",
103
+ "npm": ">=8 <=10"
104
+ }
105
+ }
@@ -1,6 +0,0 @@
1
- import { IRule } from "./IRule";
2
- export interface IPolicyMetaData {
3
- getAllRules(): IRule[];
4
- getName(): string;
5
- getDescription(): string;
6
- }
@@ -1,11 +0,0 @@
1
- import { PortalType } from '@studyportals/domain-client';
2
- import { IOrganisationsSeoDependencies } from './types/IOrganisationsSeoDependencies';
3
- import { SortingOptions } from '../enums/SortingOptions';
4
- import { BaseSeoIndexabilityPolicy } from '../common/policies/BaseSeoIndexabilityPolicy';
5
- export declare abstract class OrganisationsRuleBasedIndexabilityPolicy extends BaseSeoIndexabilityPolicy<IOrganisationsSeoDependencies> {
6
- protected readonly indexablePortalTypes: PortalType[];
7
- protected abstract readonly sortingOption: SortingOptions;
8
- constructor(dependencies: IOrganisationsSeoDependencies);
9
- protected isIndexable(): Promise<boolean>;
10
- private matchesSortingOption;
11
- }
@@ -1,19 +0,0 @@
1
- import { PortalType } from '@studyportals/domain-client';
2
- import { BaseSeoIndexabilityPolicy } from '../common/policies/BaseSeoIndexabilityPolicy';
3
- export class OrganisationsRuleBasedIndexabilityPolicy extends BaseSeoIndexabilityPolicy {
4
- indexablePortalTypes = [PortalType.MASTER];
5
- constructor(dependencies) {
6
- super(dependencies);
7
- }
8
- async isIndexable() {
9
- const isIndexable = await super.isIndexable();
10
- if (!isIndexable) {
11
- return false;
12
- }
13
- return this.indexablePortalTypes.includes(this.dependencies.portalType) && this.matchesSortingOption();
14
- }
15
- matchesSortingOption() {
16
- const dependencies = this.dependencies;
17
- return dependencies.sortingState.getSelectedOption() === this.sortingOption;
18
- }
19
- }
@@ -1,6 +0,0 @@
1
- import { BaseFilterKeyValueRule } from '../../common/rules/BaseFilterKeyValueRule';
2
- export declare class OnlineAttendanceRule extends BaseFilterKeyValueRule {
3
- constructor();
4
- getName(): string;
5
- getDescription(): string;
6
- }
@@ -1,14 +0,0 @@
1
- import { FilterKey } from '@studyportals/search-filters';
2
- import { BaseFilterKeyValueRule } from '../../common/rules/BaseFilterKeyValueRule';
3
- export class OnlineAttendanceRule extends BaseFilterKeyValueRule {
4
- constructor() {
5
- const filterKeyValues = new Map([[FilterKey.DELIVERY_METHOD, ['online']]]);
6
- super(filterKeyValues);
7
- }
8
- getName() {
9
- return 'OnlineAttendanceRule';
10
- }
11
- getDescription() {
12
- return 'Indexable if attendance is online';
13
- }
14
- }
@@ -1,4 +0,0 @@
1
- import { ISearchApplicationState } from '../common';
2
- export interface IProgrammeSearchApplicationState extends ISearchApplicationState {
3
- getPageNumber(): number;
4
- }
@@ -1,7 +0,0 @@
1
- import { ISearchDependencies } from '../common/ISearchDependencies';
2
- import { IProgrammeSearchApplicationState } from './IProgrammeSearchApplicationState';
3
- import { PortalType } from '@studyportals/domain-client';
4
- export interface IProgrammeSearchDependencies extends ISearchDependencies {
5
- portalType: PortalType;
6
- applicationState: IProgrammeSearchApplicationState;
7
- }
@@ -1 +0,0 @@
1
- export {};
@@ -1,2 +0,0 @@
1
- import { IProgrammeSearchDependencies } from "./IProgrammeSearchDependencies";
2
- export type IProgrammesSeoDependencies = IProgrammeSearchDependencies;
@@ -1 +0,0 @@
1
- export {};
@@ -1,16 +0,0 @@
1
- import { FilterKey } from '@studyportals/search-filters/server-side';
2
- import { OnlyFiltersSelectedRule } from '../../common/rules/OnlyFiltersSelectedRule';
3
- import { SingleValueSelectedForFilterRule } from '../../common/rules/SingleValueSelectedForFilterRule';
4
- import { FilterCombinations } from '../../enums/FilterCombinations';
5
- import { ProgrammesBaseIndexabilityPolicy } from '../ProgrammesBaseIndexabilityPolicy';
6
- import { IProgrammeSeoDependencies } from '../types/IProgrammeSeoDependencies';
7
- import { OnlineAttendanceRule } from '../../common/rules/OnlineAttendanceRule';
8
- export declare class AttendanceArea extends ProgrammesBaseIndexabilityPolicy {
9
- readonly name: string;
10
- readonly description: string;
11
- readonly filterKeys: FilterKey[];
12
- protected readonly rules: (SingleValueSelectedForFilterRule | OnlyFiltersSelectedRule | OnlineAttendanceRule)[];
13
- constructor(dependencies: IProgrammeSeoDependencies);
14
- protected generateUrls(): Promise<string[]>;
15
- get filterCombination(): FilterCombinations;
16
- }
@@ -1,48 +0,0 @@
1
- import { FilterKey } from '@studyportals/search-filters/server-side';
2
- import { OnlyFiltersSelectedRule } from '../../common/rules/OnlyFiltersSelectedRule';
3
- import { SingleValueSelectedForFilterRule } from '../../common/rules/SingleValueSelectedForFilterRule';
4
- import { FilterCombinations } from '../../enums/FilterCombinations';
5
- import { ProgrammesBaseIndexabilityPolicy } from '../ProgrammesBaseIndexabilityPolicy';
6
- import { AreaPresenter } from '../../presenters/AreaPresenter';
7
- import { AttendancePresenter } from '../../presenters/AttendancePresenter';
8
- import { OnlineAttendanceRule } from '../../common/rules/OnlineAttendanceRule';
9
- export class AttendanceArea extends ProgrammesBaseIndexabilityPolicy {
10
- name = 'Attendance Area Policy';
11
- description = 'Controls indexing of pages filtered by geographic areas and attendance type. (Online)';
12
- filterKeys = [FilterKey.DELIVERY_METHOD, FilterKey.AREA];
13
- rules = [
14
- new SingleValueSelectedForFilterRule(FilterKey.AREA),
15
- new SingleValueSelectedForFilterRule(FilterKey.COUNTRY),
16
- new SingleValueSelectedForFilterRule(FilterKey.DELIVERY_METHOD),
17
- new OnlyFiltersSelectedRule([FilterKey.AREA, FilterKey.DELIVERY_METHOD]),
18
- new OnlineAttendanceRule()
19
- ];
20
- constructor(dependencies) {
21
- super(dependencies);
22
- this.initateBaseRules();
23
- }
24
- async generateUrls() {
25
- const areaFragments = AreaPresenter.getInstance().getFragments();
26
- const attendanceFragments = AttendancePresenter.getInstance().getFragments();
27
- const paths = [];
28
- for (const pageNumber of this.indexablePageNumbers) {
29
- for (const attendance of attendanceFragments) {
30
- for (const area of areaFragments) {
31
- const filterKeyValues = new Map([
32
- [FilterKey.AREA, [area.id]],
33
- [FilterKey.COUNTRY, [area.countryId]],
34
- [FilterKey.DELIVERY_METHOD, [attendance.id]]
35
- ]);
36
- const result = await this.checkRulesForSitemapWithPageNumber(filterKeyValues, pageNumber);
37
- if (result) {
38
- paths.push(this.getPathWithPageNumber(`${attendance.path}/${area.path}`, pageNumber));
39
- }
40
- }
41
- }
42
- }
43
- return paths;
44
- }
45
- get filterCombination() {
46
- return FilterCombinations.ATTENDANCE_AREA;
47
- }
48
- }
@@ -1,16 +0,0 @@
1
- import { FilterKey } from '@studyportals/search-filters/server-side';
2
- import { OnlyFiltersSelectedRule } from '../../common/rules/OnlyFiltersSelectedRule';
3
- import { SingleValueSelectedForFilterRule } from '../../common/rules/SingleValueSelectedForFilterRule';
4
- import { FilterCombinations } from '../../enums/FilterCombinations';
5
- import { ProgrammesBaseIndexabilityPolicy } from '../ProgrammesBaseIndexabilityPolicy';
6
- import { IProgrammeSeoDependencies } from '../types/IProgrammeSeoDependencies';
7
- import { OnlineAttendanceRule } from '../../common/rules/OnlineAttendanceRule';
8
- export declare class AttendanceContinent extends ProgrammesBaseIndexabilityPolicy {
9
- readonly name: string;
10
- readonly description: string;
11
- readonly filterKeys: FilterKey[];
12
- protected readonly rules: (SingleValueSelectedForFilterRule | OnlyFiltersSelectedRule | OnlineAttendanceRule)[];
13
- constructor(dependencies: IProgrammeSeoDependencies);
14
- protected generateUrls(): Promise<string[]>;
15
- get filterCombination(): FilterCombinations;
16
- }
@@ -1,46 +0,0 @@
1
- import { FilterKey } from '@studyportals/search-filters/server-side';
2
- import { OnlyFiltersSelectedRule } from '../../common/rules/OnlyFiltersSelectedRule';
3
- import { SingleValueSelectedForFilterRule } from '../../common/rules/SingleValueSelectedForFilterRule';
4
- import { FilterCombinations } from '../../enums/FilterCombinations';
5
- import { ProgrammesBaseIndexabilityPolicy } from '../ProgrammesBaseIndexabilityPolicy';
6
- import { ContinentPresenter } from '../../presenters/ContinentPresenter';
7
- import { AttendancePresenter } from '../../presenters/AttendancePresenter';
8
- import { OnlineAttendanceRule } from '../../common/rules/OnlineAttendanceRule';
9
- export class AttendanceContinent extends ProgrammesBaseIndexabilityPolicy {
10
- name = 'Attendance Continent Policy';
11
- description = 'Determines indexing rules for pages filtered by tuition fee and attendance.';
12
- filterKeys = [FilterKey.CONTINENT, FilterKey.DELIVERY_METHOD];
13
- rules = [
14
- new SingleValueSelectedForFilterRule(FilterKey.DELIVERY_METHOD),
15
- new SingleValueSelectedForFilterRule(FilterKey.CONTINENT),
16
- new OnlyFiltersSelectedRule([FilterKey.DELIVERY_METHOD, FilterKey.CONTINENT]),
17
- new OnlineAttendanceRule()
18
- ];
19
- constructor(dependencies) {
20
- super(dependencies);
21
- this.initateBaseRules();
22
- }
23
- async generateUrls() {
24
- const attendanceFragments = AttendancePresenter.getInstance().getFragments();
25
- const continentFragments = ContinentPresenter.getInstance().getFragments();
26
- const paths = [];
27
- for (const pageNumber of this.indexablePageNumbers) {
28
- for (const attendance of attendanceFragments) {
29
- for (const continent of continentFragments) {
30
- const filterKeyValues = new Map([
31
- [FilterKey.DELIVERY_METHOD, [attendance.id]],
32
- [FilterKey.CONTINENT, [continent.id]]
33
- ]);
34
- const result = await this.checkRulesForSitemapWithPageNumber(filterKeyValues, pageNumber);
35
- if (result) {
36
- paths.push(this.getPathWithPageNumber(`${attendance.path}/${continent.path}`, pageNumber));
37
- }
38
- }
39
- }
40
- }
41
- return paths;
42
- }
43
- get filterCombination() {
44
- return FilterCombinations.ATTENDANCE_CONTINENT;
45
- }
46
- }
@@ -1,16 +0,0 @@
1
- import { FilterKey } from '@studyportals/search-filters/server-side';
2
- import { OnlyFiltersSelectedRule } from '../../common/rules/OnlyFiltersSelectedRule';
3
- import { SingleValueSelectedForFilterRule } from '../../common/rules/SingleValueSelectedForFilterRule';
4
- import { FilterCombinations } from '../../enums/FilterCombinations';
5
- import { OnlineAttendanceRule } from '../../common/rules/OnlineAttendanceRule';
6
- import { ProgrammesBaseIndexabilityPolicy } from '../ProgrammesBaseIndexabilityPolicy';
7
- import { IProgrammeSeoDependencies } from '../types/IProgrammeSeoDependencies';
8
- export declare class AttendanceDuration extends ProgrammesBaseIndexabilityPolicy {
9
- readonly name: string;
10
- readonly description: string;
11
- readonly filterKeys: FilterKey[];
12
- protected readonly rules: (SingleValueSelectedForFilterRule | OnlyFiltersSelectedRule | OnlineAttendanceRule)[];
13
- constructor(dependencies: IProgrammeSeoDependencies);
14
- protected generateUrls(): Promise<string[]>;
15
- get filterCombination(): FilterCombinations;
16
- }
@@ -1,48 +0,0 @@
1
- import { FilterKey } from '@studyportals/search-filters/server-side';
2
- import { OnlyFiltersSelectedRule } from '../../common/rules/OnlyFiltersSelectedRule';
3
- import { SingleValueSelectedForFilterRule } from '../../common/rules/SingleValueSelectedForFilterRule';
4
- import { FilterCombinations } from '../../enums/FilterCombinations';
5
- import { OnlineAttendanceRule } from '../../common/rules/OnlineAttendanceRule';
6
- import { ProgrammesBaseIndexabilityPolicy } from '../ProgrammesBaseIndexabilityPolicy';
7
- import { AttendancePresenter } from '../../presenters/AttendancePresenter';
8
- import { DurationPresenter } from '../../presenters/DurationPresenter';
9
- export class AttendanceDuration extends ProgrammesBaseIndexabilityPolicy {
10
- name = 'Attendance Duration Type Policy';
11
- description = 'Determines indexing rules for pages filtered by both study format (online, on-campus, etc.), and duration prioritizing durations and formats with demonstrated search demand.';
12
- filterKeys = [FilterKey.DELIVERY_METHOD, FilterKey.DURATION];
13
- rules = [
14
- new SingleValueSelectedForFilterRule(FilterKey.DELIVERY_METHOD),
15
- new SingleValueSelectedForFilterRule(FilterKey.DURATION),
16
- new OnlyFiltersSelectedRule([FilterKey.DELIVERY_METHOD, FilterKey.DURATION]),
17
- new OnlineAttendanceRule()
18
- ];
19
- constructor(dependencies) {
20
- super(dependencies);
21
- this.initateBaseRules();
22
- }
23
- async generateUrls() {
24
- const attendanceFragments = AttendancePresenter.getInstance().getFragments();
25
- const durationFragments = DurationPresenter.getInstance().getFragments();
26
- const paths = [];
27
- const allowedDurationIds = ["[360,360]"];
28
- const allowedDurations = durationFragments.filter(duration => allowedDurationIds.includes(duration.id));
29
- for (const pageNumber of this.indexablePageNumbers) {
30
- for (const attendance of attendanceFragments) {
31
- for (const duration of allowedDurations) {
32
- const filterKeyValues = new Map([
33
- [FilterKey.DELIVERY_METHOD, [attendance.id]],
34
- [FilterKey.DURATION, [duration.id]]
35
- ]);
36
- const result = await this.checkRulesForSitemapWithPageNumber(filterKeyValues, pageNumber);
37
- if (result) {
38
- paths.push(this.getPathWithPageNumber(`${attendance.path}/${duration.path}`, pageNumber));
39
- }
40
- }
41
- }
42
- }
43
- return paths;
44
- }
45
- get filterCombination() {
46
- return FilterCombinations.ATTENDANCE_DURATION;
47
- }
48
- }