@studyportals/fawkes 8.2.2 → 8.2.4-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 (89) hide show
  1. package/README.md +176 -176
  2. package/dist/src/common/IPresenter.d.ts +1 -1
  3. package/dist/src/enums/AttendanceFilterOptionValue.d.ts +5 -0
  4. package/dist/src/enums/AttendanceFilterOptionValue.js +6 -0
  5. package/dist/src/enums/DegreeTypeFilterOptionValue.d.ts +29 -0
  6. package/dist/src/enums/DegreeTypeFilterOptionValue.js +30 -0
  7. package/dist/src/enums/DurationFilterOptionValue.d.ts +16 -0
  8. package/dist/src/enums/DurationFilterOptionValue.js +17 -0
  9. package/dist/src/enums/EducationalFormFilterOptionValue.d.ts +8 -0
  10. package/dist/src/enums/EducationalFormFilterOptionValue.js +9 -0
  11. package/dist/src/enums/FilterCombinations.d.ts +1 -0
  12. package/dist/src/enums/FilterCombinations.js +1 -0
  13. package/dist/src/enums/FilterKey.d.ts +21 -0
  14. package/dist/src/enums/FilterKey.js +22 -0
  15. package/dist/src/enums/FormatFilterOptionValue.d.ts +4 -0
  16. package/dist/src/enums/FormatFilterOptionValue.js +5 -0
  17. package/dist/src/enums/SpecialProgrammesFilterOptionValue.d.ts +5 -0
  18. package/dist/src/enums/SpecialProgrammesFilterOptionValue.js +6 -0
  19. package/dist/src/enums/TuitionFeeFilterOptionValue.d.ts +3 -0
  20. package/dist/src/enums/TuitionFeeFilterOptionValue.js +4 -0
  21. package/dist/src/organisations/SearchIndexabilityManager.js +2 -1
  22. package/dist/src/organisations/policies/index.d.ts +1 -0
  23. package/dist/src/organisations/policies/index.js +1 -0
  24. package/dist/src/organisations/policies/our-picks/City.d.ts +12 -0
  25. package/dist/src/organisations/policies/our-picks/City.js +35 -0
  26. package/dist/src/organisations/rules/OnlyFullLocationFiltersSelectedRule.d.ts +10 -0
  27. package/dist/src/organisations/rules/OnlyFullLocationFiltersSelectedRule.js +32 -0
  28. package/dist/src/presenters/AreaPresenter.d.ts +1 -0
  29. package/dist/src/presenters/AreaPresenter.js +3 -0
  30. package/dist/src/presenters/CityPresenter.d.ts +14 -0
  31. package/dist/src/presenters/CityPresenter.js +60 -0
  32. package/dist/src/presenters/fragments/ICityFragment.d.ts +5 -0
  33. package/dist/src/programmes/policies/CountryAttendanceDegree.js +1 -1
  34. package/dist/src/programmes/policies/CountryDurationDegree.js +1 -1
  35. package/dist/src/programmes/policies/CountryEducationalForm.js +1 -1
  36. package/dist/src/programmes/policies/DisciplineArea.d.ts +1 -1
  37. package/dist/src/programmes/policies/DisciplineArea.js +1 -1
  38. package/dist/src/programmes/policies/DisciplineCountryEducationalForm.js +1 -1
  39. package/dist/src/programmes/policies/DisciplineEducationalForm.js +1 -1
  40. package/dist/src/programmes/rules/ErasmusOrJointSpecialProgrammesRule.js +2 -2
  41. package/dist/src/sitemap-generator/ISearchApiClient.d.ts +9 -0
  42. package/dist/src/sitemap-generator/OrganisationsSitemapUrlGeneratorManager.js +2 -1
  43. package/dist/src/structured-data/ScholarshipStructuredDataFactory.d.ts +17 -0
  44. package/dist/src/structured-data/ScholarshipStructuredDataFactory.js +63 -0
  45. package/dist/src/structured-data/SearchStructuredDataFactory.d.ts +16 -3
  46. package/dist/src/structured-data/SearchStructuredDataFactory.js +71 -7
  47. package/dist/src/structured-data/dto/EntityDTO.d.ts +2 -0
  48. package/dist/src/structured-data/dto/PaywallDTO.d.ts +14 -0
  49. package/dist/src/structured-data/dto/index.d.ts +1 -0
  50. package/dist/src/structured-data/dto/index.js +1 -0
  51. package/dist/src/structured-data/index.d.ts +1 -0
  52. package/dist/src/structured-data/index.js +1 -0
  53. package/package.json +105 -105
  54. package/dist/src/common/IPolicyMetaData.d.ts +0 -6
  55. package/dist/src/organisations/OrganisationsRuleBasedIndexabilityPolicy.d.ts +0 -11
  56. package/dist/src/organisations/OrganisationsRuleBasedIndexabilityPolicy.js +0 -19
  57. package/dist/src/organisations/rules/OnlineAttendanceRule.d.ts +0 -6
  58. package/dist/src/organisations/rules/OnlineAttendanceRule.js +0 -14
  59. package/dist/src/programmes/IProgrammeSearchApplicationState.d.ts +0 -4
  60. package/dist/src/programmes/IProgrammeSearchDependencies.d.ts +0 -7
  61. package/dist/src/programmes/IProgrammeSearchDependencies.js +0 -1
  62. package/dist/src/programmes/IProgrammesSeoDependencies.d.ts +0 -2
  63. package/dist/src/programmes/IProgrammesSeoDependencies.js +0 -1
  64. package/dist/src/programmes/policies/DisciplineCountryDegree.d.ts +0 -16
  65. package/dist/src/programmes/policies/DisciplineCountryDegree.js +0 -53
  66. package/dist/src/programmes/rules/DegreeAttendanceSpecificRule.d.ts +0 -10
  67. package/dist/src/programmes/rules/DegreeAttendanceSpecificRule.js +0 -42
  68. package/dist/src/programmes/rules/DegreeCountrySpecificRule.d.ts +0 -10
  69. package/dist/src/programmes/rules/DegreeCountrySpecificRule.js +0 -43
  70. package/dist/src/programmes/rules/DegreeCountryTuitionFeeRule.d.ts +0 -11
  71. package/dist/src/programmes/rules/DegreeCountryTuitionFeeRule.js +0 -40
  72. package/dist/src/programmes/rules/MBACountryAttendanceRule.d.ts +0 -11
  73. package/dist/src/programmes/rules/MBACountryAttendanceRule.js +0 -40
  74. package/dist/src/programmes/rules/MasterOfArtsDisciplineRule.d.ts +0 -10
  75. package/dist/src/programmes/rules/MasterOfArtsDisciplineRule.js +0 -41
  76. package/dist/src/programmes/rules/MasterOfEducationCountryDisciplineRule.d.ts +0 -11
  77. package/dist/src/programmes/rules/MasterOfEducationCountryDisciplineRule.js +0 -69
  78. package/dist/src/programmes/rules/MasterOfLawsCountryAttendanceRule.d.ts +0 -12
  79. package/dist/src/programmes/rules/MasterOfLawsCountryAttendanceRule.js +0 -43
  80. package/dist/src/programmes/rules/MasterOfLawsCountryTuitionFeeRule.d.ts +0 -12
  81. package/dist/src/programmes/rules/MasterOfLawsCountryTuitionFeeRule.js +0 -46
  82. package/dist/src/programmes/rules/MasterOfPhilosophyCountryAttendanceRule.d.ts +0 -12
  83. package/dist/src/programmes/rules/MasterOfPhilosophyCountryAttendanceRule.js +0 -43
  84. package/dist/src/programmes/rules/MasterOfScienceDisciplineRule.d.ts +0 -10
  85. package/dist/src/programmes/rules/MasterOfScienceDisciplineRule.js +0 -41
  86. package/dist/src/sitemap-generator/IPageNumberProvider.d.ts +0 -3
  87. package/dist/src/sitemap-generator/IPageNumberProvider.js +0 -1
  88. /package/dist/src/{common/IPolicyMetaData.js → presenters/fragments/ICityFragment.js} +0 -0
  89. /package/dist/src/{programmes/IProgrammeSearchApplicationState.js → structured-data/dto/PaywallDTO.js} +0 -0
@@ -1,11 +0,0 @@
1
- import { ISearchDependencies } from '../../common/ISearchDependencies';
2
- import { FilterKeyValuesMap } from '../../common/FilterKeyValuesMap';
3
- import { BaseProgrammeRule } from '../BaseProgrammeRule';
4
- export declare class MasterOfEducationCountryDisciplineRule extends BaseProgrammeRule {
5
- private readonly educationDisciplineIds;
6
- private readonly allowedCountryIds;
7
- getName(): string;
8
- getDescription(): string;
9
- forSearch(dependencies: ISearchDependencies): Promise<boolean>;
10
- forSitemapGenerator(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
11
- }
@@ -1,69 +0,0 @@
1
- import { FilterKey } from '@studyportals/search-filters';
2
- import { DegreeTypeFilterOptionValue } from '@studyportals/search-filters';
3
- import { BaseProgrammeRule } from '../BaseProgrammeRule';
4
- export class MasterOfEducationCountryDisciplineRule extends BaseProgrammeRule {
5
- educationDisciplineIds = [
6
- '289', // Education & Training (main discipline)
7
- '290', // Adult Education
8
- '360', // Art Education
9
- '291', // Coaching
10
- '292', // School Counselling
11
- '333', // Early Childhood Education
12
- '8', // Education
13
- '349', // Educational Leadership
14
- '293', // Educational Psychology
15
- '98', // Educational Research
16
- '371', // Health Education
17
- '363', // Higher Education
18
- '355', // Instructional Design
19
- '370', // Literacy Education
20
- '348', // Primary Education
21
- '97', // Special Education
22
- '359', // Secondary Education
23
- '345', // STEM Education
24
- '295', // Teaching
25
- '358' // Teaching English as a Foreign Language
26
- ];
27
- // Australia (202), Canada (32)
28
- allowedCountryIds = ['202', '32'];
29
- getName() {
30
- return 'MasterOfEducationCountryDisciplineRule';
31
- }
32
- getDescription() {
33
- return 'Indexes: master-of-education (Australia, Canada) + education disciplines only';
34
- }
35
- forSearch(dependencies) {
36
- const { seoInfoBase, filterState } = dependencies;
37
- const degreeTypeValue = seoInfoBase.getFilterOptionValueBy(FilterKey.DEGREE_TYPE, filterState);
38
- const countryValue = seoInfoBase.getFilterOptionValueBy(FilterKey.COUNTRY, filterState);
39
- const disciplineValue = seoInfoBase.getFilterOptionValueBy(FilterKey.DISCIPLINES, filterState);
40
- if (degreeTypeValue !== DegreeTypeFilterOptionValue.MED) {
41
- return Promise.resolve(true);
42
- }
43
- if (!countryValue || !disciplineValue) {
44
- return Promise.resolve(false);
45
- }
46
- if (!this.allowedCountryIds.includes(countryValue)) {
47
- return Promise.resolve(false);
48
- }
49
- return Promise.resolve(this.educationDisciplineIds.includes(disciplineValue));
50
- }
51
- forSitemapGenerator(filterKeyValues) {
52
- const degreeTypeValues = filterKeyValues.get(FilterKey.DEGREE_TYPE);
53
- const countryValues = filterKeyValues.get(FilterKey.COUNTRY);
54
- const disciplineValues = filterKeyValues.get(FilterKey.DISCIPLINES);
55
- if (!degreeTypeValues?.length || !countryValues?.length || !disciplineValues?.length) {
56
- return Promise.resolve(false);
57
- }
58
- const degreeTypeValue = degreeTypeValues[0];
59
- const countryValue = countryValues[0];
60
- const disciplineValue = disciplineValues[0];
61
- if (degreeTypeValue !== DegreeTypeFilterOptionValue.MED.valueOf()) {
62
- return Promise.resolve(true);
63
- }
64
- if (!this.allowedCountryIds.includes(countryValue)) {
65
- return Promise.resolve(false);
66
- }
67
- return Promise.resolve(this.educationDisciplineIds.includes(disciplineValue));
68
- }
69
- }
@@ -1,12 +0,0 @@
1
- import { ISearchDependencies } from '../../common/ISearchDependencies';
2
- import { FilterKeyValuesMap } from '../../common/FilterKeyValuesMap';
3
- import { BaseProgrammeRule } from '../BaseProgrammeRule';
4
- export declare class MasterOfLawsCountryAttendanceRule extends BaseProgrammeRule {
5
- private readonly degreeValue;
6
- private readonly attendanceValue;
7
- private readonly allowedCountryIds;
8
- getName(): string;
9
- getDescription(): string;
10
- forSearch(dependencies: ISearchDependencies): Promise<boolean>;
11
- forSitemapGenerator(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
12
- }
@@ -1,43 +0,0 @@
1
- import { FilterKey } from '@studyportals/search-filters';
2
- import { BaseProgrammeRule } from '../BaseProgrammeRule';
3
- export class MasterOfLawsCountryAttendanceRule extends BaseProgrammeRule {
4
- degreeValue = 'master-of-laws';
5
- attendanceValue = 'online';
6
- allowedCountryIds = ['82', '30', '32', '108'];
7
- getName() {
8
- return 'MasterOfLawsCountryAttendanceRule';
9
- }
10
- getDescription() {
11
- return 'Indexes: master-of-laws (USA, UK, Canada, India) + online attendance';
12
- }
13
- forSearch(dependencies) {
14
- const { seoInfoBase, filterState } = dependencies;
15
- const degreeTypeValue = seoInfoBase.getFilterOptionValueBy(FilterKey.DEGREE_TYPE, filterState);
16
- const countryValue = seoInfoBase.getFilterOptionValueBy(FilterKey.COUNTRY, filterState);
17
- const attendanceValue = seoInfoBase.getFilterOptionValueBy(FilterKey.DELIVERY_METHOD, filterState);
18
- if (degreeTypeValue !== this.degreeValue) {
19
- return Promise.resolve(true);
20
- }
21
- if (!countryValue || !attendanceValue) {
22
- return Promise.resolve(false);
23
- }
24
- return Promise.resolve(this.allowedCountryIds.includes(countryValue) &&
25
- attendanceValue === this.attendanceValue);
26
- }
27
- forSitemapGenerator(filterKeyValues) {
28
- const degreeTypeValues = filterKeyValues.get(FilterKey.DEGREE_TYPE);
29
- const countryValues = filterKeyValues.get(FilterKey.COUNTRY);
30
- const attendanceValues = filterKeyValues.get(FilterKey.DELIVERY_METHOD);
31
- if (!degreeTypeValues?.length || !countryValues?.length || !attendanceValues?.length) {
32
- return Promise.resolve(false);
33
- }
34
- const degreeTypeValue = degreeTypeValues[0];
35
- const countryValue = countryValues[0];
36
- const attendanceValue = attendanceValues[0];
37
- if (degreeTypeValue !== this.degreeValue) {
38
- return Promise.resolve(true);
39
- }
40
- return Promise.resolve(this.allowedCountryIds.includes(countryValue) &&
41
- attendanceValue === this.attendanceValue);
42
- }
43
- }
@@ -1,12 +0,0 @@
1
- import { ISearchDependencies } from '../../common/ISearchDependencies';
2
- import { FilterKeyValuesMap } from '../../common/FilterKeyValuesMap';
3
- import { BaseProgrammeRule } from '../BaseProgrammeRule';
4
- export declare class MasterOfLawsCountryTuitionFeeRule extends BaseProgrammeRule {
5
- private readonly degreeValue;
6
- private readonly allowedCountryIds;
7
- private readonly tuitionFeeValue;
8
- getName(): string;
9
- getDescription(): string;
10
- forSearch(dependencies: ISearchDependencies): Promise<boolean>;
11
- forSitemapGenerator(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
12
- }
@@ -1,46 +0,0 @@
1
- import { FilterKey } from '@studyportals/search-filters';
2
- import { TuitionFeeFilterOptionValue } from '@studyportals/search-filters';
3
- import { BaseProgrammeRule } from '../BaseProgrammeRule';
4
- export class MasterOfLawsCountryTuitionFeeRule extends BaseProgrammeRule {
5
- degreeValue = 'master-of-laws';
6
- allowedCountryIds = ['82', '30', '32', '108']; // USA, UK, Canada, India
7
- tuitionFeeValue = TuitionFeeFilterOptionValue.ZERO_TO_TWO_THOUSAND_FIVE_HUNDRED;
8
- getName() {
9
- return 'MasterOfLawsCountryTuitionFeeRule';
10
- }
11
- getDescription() {
12
- return 'Indexes: master-of-laws (USA, UK, Canada, India) + affordable tuition (0-2500)';
13
- }
14
- forSearch(dependencies) {
15
- const { seoInfoBase, filterState } = dependencies;
16
- const degreeTypeValue = seoInfoBase.getFilterOptionValueBy(FilterKey.DEGREE_TYPE, filterState);
17
- const countryValue = seoInfoBase.getFilterOptionValueBy(FilterKey.COUNTRY, filterState);
18
- const tuitionFeeValue = seoInfoBase.getFilterOptionValueBy(FilterKey.TUITION_FEE, filterState);
19
- if (degreeTypeValue !== this.degreeValue) {
20
- return Promise.resolve(true);
21
- }
22
- if (!countryValue || !tuitionFeeValue) {
23
- return Promise.resolve(false);
24
- }
25
- return Promise.resolve(this.allowedCountryIds.includes(countryValue) &&
26
- tuitionFeeValue === this.tuitionFeeValue);
27
- }
28
- forSitemapGenerator(filterKeyValues) {
29
- const degreeTypeValues = filterKeyValues.get(FilterKey.DEGREE_TYPE);
30
- const countryValues = filterKeyValues.get(FilterKey.COUNTRY);
31
- const tuitionFeeValues = filterKeyValues.get(FilterKey.TUITION_FEE);
32
- if (!degreeTypeValues?.length || !countryValues?.length || !tuitionFeeValues?.length) {
33
- return Promise.resolve(false);
34
- }
35
- const degreeTypeValue = degreeTypeValues[0];
36
- const countryValue = countryValues[0];
37
- const tuitionFeeValue = tuitionFeeValues[0];
38
- // This rule only applies to Master of Laws
39
- if (degreeTypeValue !== this.degreeValue) {
40
- return Promise.resolve(true); // Rule doesn't apply to other degrees
41
- }
42
- // Must be in allowed countries and have affordable tuition
43
- return Promise.resolve(this.allowedCountryIds.includes(countryValue) &&
44
- tuitionFeeValue === this.tuitionFeeValue);
45
- }
46
- }
@@ -1,12 +0,0 @@
1
- import { ISearchDependencies } from '../../common/ISearchDependencies';
2
- import { FilterKeyValuesMap } from '../../common/FilterKeyValuesMap';
3
- import { BaseProgrammeRule } from '../BaseProgrammeRule';
4
- export declare class MasterOfPhilosophyCountryAttendanceRule extends BaseProgrammeRule {
5
- private readonly degreeValue;
6
- private readonly attendanceValue;
7
- private readonly allowedCountryIds;
8
- getName(): string;
9
- getDescription(): string;
10
- forSearch(dependencies: ISearchDependencies): Promise<boolean>;
11
- forSitemapGenerator(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
12
- }
@@ -1,43 +0,0 @@
1
- import { FilterKey } from '@studyportals/search-filters';
2
- import { BaseProgrammeRule } from '../BaseProgrammeRule';
3
- export class MasterOfPhilosophyCountryAttendanceRule extends BaseProgrammeRule {
4
- degreeValue = 'master-of-philosophy';
5
- attendanceValue = 'online';
6
- allowedCountryIds = ['82', '30', '108']; // USA, UK, India
7
- getName() {
8
- return 'MasterOfPhilosophyCountryAttendanceRule';
9
- }
10
- getDescription() {
11
- return 'Indexes: master-of-philosophy (USA, UK, India) + online attendance';
12
- }
13
- forSearch(dependencies) {
14
- const { seoInfoBase, filterState } = dependencies;
15
- const degreeTypeValue = seoInfoBase.getFilterOptionValueBy(FilterKey.DEGREE_TYPE, filterState);
16
- const countryValue = seoInfoBase.getFilterOptionValueBy(FilterKey.COUNTRY, filterState);
17
- const attendanceValue = seoInfoBase.getFilterOptionValueBy(FilterKey.DELIVERY_METHOD, filterState);
18
- if (degreeTypeValue !== this.degreeValue) {
19
- return Promise.resolve(true);
20
- }
21
- if (!countryValue || !attendanceValue) {
22
- return Promise.resolve(false);
23
- }
24
- return Promise.resolve(this.allowedCountryIds.includes(countryValue) &&
25
- attendanceValue === this.attendanceValue);
26
- }
27
- forSitemapGenerator(filterKeyValues) {
28
- const degreeTypeValues = filterKeyValues.get(FilterKey.DEGREE_TYPE);
29
- const countryValues = filterKeyValues.get(FilterKey.COUNTRY);
30
- const attendanceValues = filterKeyValues.get(FilterKey.DELIVERY_METHOD);
31
- if (!degreeTypeValues?.length || !countryValues?.length || !attendanceValues?.length) {
32
- return Promise.resolve(false);
33
- }
34
- const degreeTypeValue = degreeTypeValues[0];
35
- const countryValue = countryValues[0];
36
- const attendanceValue = attendanceValues[0];
37
- if (degreeTypeValue !== this.degreeValue) {
38
- return Promise.resolve(true);
39
- }
40
- return Promise.resolve(this.allowedCountryIds.includes(countryValue) &&
41
- attendanceValue === this.attendanceValue);
42
- }
43
- }
@@ -1,10 +0,0 @@
1
- import { ISearchDependencies } from '../../common/ISearchDependencies';
2
- import { FilterKeyValuesMap } from '../../common/FilterKeyValuesMap';
3
- import { BaseProgrammeRule } from '../BaseProgrammeRule';
4
- export declare class MasterOfScienceDisciplineRule extends BaseProgrammeRule {
5
- private readonly degreeValue;
6
- getName(): string;
7
- getDescription(): string;
8
- forSearch(dependencies: ISearchDependencies): Promise<boolean>;
9
- forSitemapGenerator(filterKeyValues: FilterKeyValuesMap): Promise<boolean>;
10
- }
@@ -1,41 +0,0 @@
1
- import { FilterKey } from '@studyportals/search-filters';
2
- import { BaseProgrammeRule } from '../BaseProgrammeRule';
3
- export class MasterOfScienceDisciplineRule extends BaseProgrammeRule {
4
- // Master of Science accepts all disciplines
5
- degreeValue = 'master-of-science';
6
- getName() {
7
- return 'MasterOfScienceDisciplineRule';
8
- }
9
- getDescription() {
10
- return 'Indexes: master-of-science + all disciplines';
11
- }
12
- forSearch(dependencies) {
13
- const { seoInfoBase, filterState } = dependencies;
14
- const degreeTypeValue = seoInfoBase.getFilterOptionValueBy(FilterKey.DEGREE_TYPE, filterState);
15
- const disciplineValue = seoInfoBase.getFilterOptionValueBy(FilterKey.DISCIPLINES, filterState);
16
- // This rule only applies to Master of Science
17
- if (degreeTypeValue !== this.degreeValue) {
18
- return Promise.resolve(true); // Rule doesn't apply to other degrees
19
- }
20
- // Must have a discipline selected
21
- if (!disciplineValue) {
22
- return Promise.resolve(false);
23
- }
24
- // Master of Science accepts all disciplines
25
- return Promise.resolve(true);
26
- }
27
- forSitemapGenerator(filterKeyValues) {
28
- const degreeTypeValues = filterKeyValues.get(FilterKey.DEGREE_TYPE);
29
- const disciplineValues = filterKeyValues.get(FilterKey.DISCIPLINES);
30
- if (!degreeTypeValues?.length || !disciplineValues?.length) {
31
- return Promise.resolve(false);
32
- }
33
- const degreeTypeValue = degreeTypeValues[0];
34
- // This rule only applies to Master of Science
35
- if (degreeTypeValue !== this.degreeValue) {
36
- return Promise.resolve(true); // Rule doesn't apply to other degrees
37
- }
38
- // Master of Science accepts all disciplines
39
- return Promise.resolve(true);
40
- }
41
- }
@@ -1,3 +0,0 @@
1
- export interface IPageNumberProvider {
2
- getPageNumber(): number;
3
- }
@@ -1 +0,0 @@
1
- export {};