@studyportals/fawkes 8.2.3 → 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.
- package/README.md +176 -176
- package/dist/src/common/IPresenter.d.ts +1 -1
- package/dist/src/enums/AttendanceFilterOptionValue.d.ts +5 -0
- package/dist/src/enums/AttendanceFilterOptionValue.js +6 -0
- package/dist/src/enums/DegreeTypeFilterOptionValue.d.ts +29 -0
- package/dist/src/enums/DegreeTypeFilterOptionValue.js +30 -0
- package/dist/src/enums/DurationFilterOptionValue.d.ts +16 -0
- package/dist/src/enums/DurationFilterOptionValue.js +17 -0
- package/dist/src/enums/EducationalFormFilterOptionValue.d.ts +8 -0
- package/dist/src/enums/EducationalFormFilterOptionValue.js +9 -0
- package/dist/src/enums/FilterCombinations.d.ts +1 -0
- package/dist/src/enums/FilterCombinations.js +1 -0
- package/dist/src/enums/FilterKey.d.ts +21 -0
- package/dist/src/enums/FilterKey.js +22 -0
- package/dist/src/enums/FormatFilterOptionValue.d.ts +4 -0
- package/dist/src/enums/FormatFilterOptionValue.js +5 -0
- package/dist/src/enums/SpecialProgrammesFilterOptionValue.d.ts +5 -0
- package/dist/src/enums/SpecialProgrammesFilterOptionValue.js +6 -0
- package/dist/src/enums/TuitionFeeFilterOptionValue.d.ts +3 -0
- package/dist/src/enums/TuitionFeeFilterOptionValue.js +4 -0
- package/dist/src/organisations/SearchIndexabilityManager.js +2 -1
- package/dist/src/organisations/policies/index.d.ts +1 -0
- package/dist/src/organisations/policies/index.js +1 -0
- package/dist/src/organisations/policies/our-picks/City.d.ts +12 -0
- package/dist/src/organisations/policies/our-picks/City.js +35 -0
- package/dist/src/organisations/rules/AtLeastTwoRankedResultsRule.d.ts +13 -0
- package/dist/src/organisations/rules/AtLeastTwoRankedResultsRule.js +26 -0
- package/dist/src/organisations/rules/OnlyFullLocationFiltersSelectedRule.d.ts +10 -0
- package/dist/src/organisations/rules/OnlyFullLocationFiltersSelectedRule.js +32 -0
- package/dist/src/presenters/AreaPresenter.d.ts +1 -0
- package/dist/src/presenters/AreaPresenter.js +3 -0
- package/dist/src/presenters/CityPresenter.d.ts +14 -0
- package/dist/src/presenters/CityPresenter.js +60 -0
- package/dist/src/presenters/fragments/ICityFragment.d.ts +5 -0
- package/dist/src/presenters/fragments/ICityFragment.js +1 -0
- package/dist/src/programmes/policies/CountryAttendanceDegree.js +1 -1
- package/dist/src/programmes/policies/CountryDurationDegree.js +1 -1
- package/dist/src/programmes/policies/CountryEducationalForm.js +1 -1
- package/dist/src/programmes/policies/DisciplineArea.d.ts +1 -1
- package/dist/src/programmes/policies/DisciplineArea.js +1 -1
- package/dist/src/programmes/policies/DisciplineCountryEducationalForm.js +1 -1
- package/dist/src/programmes/policies/DisciplineEducationalForm.js +1 -1
- package/dist/src/programmes/rules/AtLeastSevenResultsRule.d.ts +15 -0
- package/dist/src/programmes/rules/AtLeastSevenResultsRule.js +30 -0
- package/dist/src/programmes/rules/ErasmusOrJointSpecialProgrammesRule.js +2 -2
- package/dist/src/sitemap-generator/ISearchApiClient.d.ts +9 -0
- package/dist/src/sitemap-generator/OrganisationsSitemapUrlGeneratorManager.js +2 -1
- package/package.json +105 -105
package/README.md
CHANGED
|
@@ -1,176 +1,176 @@
|
|
|
1
|
-
# fawkes
|
|
2
|
-
|
|
3
|
-
This project is used to centralize indexability logic for our Search
|
|
4
|
-
microservices and Sitemap Generator. The main purpose is to completely remove
|
|
5
|
-
discrepancies between pages indexed by Search and page URLs stored in Sitemap.
|
|
6
|
-
|
|
7
|
-
Link to documentation: https://studyportals.atlassian.net/wiki/x/BwAdvw
|
|
8
|
-
|
|
9
|
-
## Base structure
|
|
10
|
-
|
|
11
|
-
- organisations-seo (used by Organisation Search)
|
|
12
|
-
- scholarships-seo (used by Scholarship Search)
|
|
13
|
-
- sitemap-generator-seo (used by Sitemap Generator)
|
|
14
|
-
- src
|
|
15
|
-
- common
|
|
16
|
-
- organisations
|
|
17
|
-
- scholarships
|
|
18
|
-
- sitemap-generator
|
|
19
|
-
|
|
20
|
-
# Automatic Documentation System
|
|
21
|
-
|
|
22
|
-
## Overview
|
|
23
|
-
|
|
24
|
-
This system automatically generates and maintains documentation for Fawkes
|
|
25
|
-
indexing rules across multiple projects. It creates a hierarchical structure of
|
|
26
|
-
Confluence pages that document all indexing policies and rules, ensuring that
|
|
27
|
-
the documentation is always up-to-date with the actual codebase.
|
|
28
|
-
|
|
29
|
-
Link to documentation:
|
|
30
|
-
[Fawkes Indexing Rules Documentation](https://studyportals.atlassian.net/wiki/spaces/T/pages/3494969354/Fawkes+Indexing+Rules+Documentation)
|
|
31
|
-
|
|
32
|
-
## Features
|
|
33
|
-
|
|
34
|
-
- **Dynamic Documentation**: Automatically extracts indexing rules and policies
|
|
35
|
-
directly from the codebase
|
|
36
|
-
- **Multi-Page Structure**: Creates a main index page with separate pages for
|
|
37
|
-
each project
|
|
38
|
-
- **Hierarchical Organization**: Structures content as Projects → Policies →
|
|
39
|
-
Rules
|
|
40
|
-
- **Automatic Page Creation**: Intelligently creates or updates pages as needed
|
|
41
|
-
- **Cross-Page Navigation**: Provides intuitive navigation between all pages
|
|
42
|
-
|
|
43
|
-
## Architecture
|
|
44
|
-
|
|
45
|
-
The system follows SOLID design principles to ensure maintainability and
|
|
46
|
-
extensibility:
|
|
47
|
-
|
|
48
|
-
- **Single Responsibility**: Each class has one specific responsibility
|
|
49
|
-
- **Open/Closed**: Easily extendable without modifying existing code
|
|
50
|
-
- **Liskov Substitution**: Interchangeable components through well-defined
|
|
51
|
-
interfaces
|
|
52
|
-
- **Interface Segregation**: Clean, focused interfaces
|
|
53
|
-
- **Dependency Inversion**: High-level modules depend on abstractions
|
|
54
|
-
|
|
55
|
-
### Key Components
|
|
56
|
-
|
|
57
|
-
1. **Content Builder**: Extracts project, policy, and rule data from the Fawkes
|
|
58
|
-
system
|
|
59
|
-
2. **Policy Fetchers**: Project-specific components that fetch and format policy
|
|
60
|
-
data
|
|
61
|
-
3. **Document Builder**: Generates structured HTML content for Confluence pages
|
|
62
|
-
4. **Confluence Updater**: Handles creation and updating of Confluence pages
|
|
63
|
-
5. **Token Retriever**: Securely retrieves API token for Confluence access
|
|
64
|
-
|
|
65
|
-
## How It Works
|
|
66
|
-
|
|
67
|
-
1. The system starts by collecting all project data using the `ContentBuilder`
|
|
68
|
-
2. For each project, it extracts policies and rules using project-specific
|
|
69
|
-
fetchers
|
|
70
|
-
3. The `DocumentBuilder` generates the content for the main index page and each
|
|
71
|
-
project page
|
|
72
|
-
4. The `ConfluenceUpdater` creates or updates pages in Confluence as needed
|
|
73
|
-
5. Each project page links back to the main index, and the main index links to
|
|
74
|
-
all project pages
|
|
75
|
-
|
|
76
|
-
## Setup and Configuration
|
|
77
|
-
|
|
78
|
-
### Environment Variables
|
|
79
|
-
|
|
80
|
-
The system requires the following environment variables:
|
|
81
|
-
|
|
82
|
-
```
|
|
83
|
-
CONFLUENCE_EMAIL=your-email@example.com
|
|
84
|
-
CONFLUENCE_API_TOKEN=your-api-token
|
|
85
|
-
CONFLUENCE_BASE_URL=https://your-instance.atlassian.net
|
|
86
|
-
CONFLUENCE_SPACE_KEY=YOUR_SPACE_KEY
|
|
87
|
-
CONFLUENCE_MAIN_PAGE_TITLE=Fawkes Indexing Rules Documentation
|
|
88
|
-
```
|
|
89
|
-
|
|
90
|
-
> **Important Note on Credentials**: Currently, the system uses personal
|
|
91
|
-
> credentials (email and API token) for Confluence access. This is a temporary
|
|
92
|
-
> solution and should be replaced with a team or service account in the future
|
|
93
|
-
> to avoid dependency on a specific individual's account.
|
|
94
|
-
|
|
95
|
-
### Deployment and Triggering
|
|
96
|
-
|
|
97
|
-
The system runs as an AWS Lambda function and is automatically triggered as part
|
|
98
|
-
of the CI/CD pipeline. This ensures documentation is always updated whenever new
|
|
99
|
-
code is deployed:
|
|
100
|
-
|
|
101
|
-
```yaml
|
|
102
|
-
# buildspec.yml (excerpt)
|
|
103
|
-
post_build:
|
|
104
|
-
commands:
|
|
105
|
-
- |
|
|
106
|
-
if [ -z "$PR_ID" ]; then
|
|
107
|
-
LAMBDA_NAME="FawkesConfluenceUpdater-$STAGE"
|
|
108
|
-
echo "Invoking Lambda function $LAMBDA_NAME"
|
|
109
|
-
echo '{"source":"cicd-pipeline","timestamp":"'$(date -u +"%Y-%m-%dT%H:%M:%SZ")'"}' > payload.json
|
|
110
|
-
aws lambda invoke --function-name $LAMBDA_NAME --invocation-type Event --payload fileb://payload.json response.json || echo "Lambda invocation failed, but continuing"
|
|
111
|
-
fi
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
**Trigger Flow:**
|
|
115
|
-
|
|
116
|
-
1. When code is pushed to the `main` branch, the CI/CD pipeline is triggered
|
|
117
|
-
2. After successful deployment of a new Fawkes version, the post-build phase
|
|
118
|
-
executes
|
|
119
|
-
3. The Lambda function is invoked with a simple payload containing the source
|
|
120
|
-
and timestamp
|
|
121
|
-
4. The Lambda function authenticates with Confluence and executes the
|
|
122
|
-
documentation generation process
|
|
123
|
-
5. This only happens for production deployments (not PR builds)
|
|
124
|
-
|
|
125
|
-
This automated approach ensures documentation stays in sync with the actual
|
|
126
|
-
codebase without manual intervention.
|
|
127
|
-
|
|
128
|
-
## Scalability and Extension
|
|
129
|
-
|
|
130
|
-
### Adding New Projects
|
|
131
|
-
|
|
132
|
-
To add documentation for a new project:
|
|
133
|
-
|
|
134
|
-
1. Create a new class that implements the `IPolicyFetcher` interface
|
|
135
|
-
2. Implement the `getProjectName()` and `fetchPolicies()` methods
|
|
136
|
-
3. Register the new fetcher in the `ContentBuilder` constructor
|
|
137
|
-
|
|
138
|
-
Example:
|
|
139
|
-
|
|
140
|
-
```typescript
|
|
141
|
-
export class NewProjectPolicyFetcher implements IPolicyFetcher {
|
|
142
|
-
getProjectName(): string {
|
|
143
|
-
return 'New Project Name';
|
|
144
|
-
}
|
|
145
|
-
|
|
146
|
-
fetchPolicies(): IPolicy[] {
|
|
147
|
-
// Implement policy fetching logic
|
|
148
|
-
return [...policies];
|
|
149
|
-
}
|
|
150
|
-
}
|
|
151
|
-
|
|
152
|
-
// Then update ContentBuilder:
|
|
153
|
-
constructor(fetchers?: IPolicyFetcher[]) {
|
|
154
|
-
this.policyFetchers = fetchers || [
|
|
155
|
-
// Existing fetchers
|
|
156
|
-
new NewProjectPolicyFetcher()
|
|
157
|
-
];
|
|
158
|
-
}
|
|
159
|
-
```
|
|
160
|
-
|
|
161
|
-
### Customizing Page Content
|
|
162
|
-
|
|
163
|
-
The `DocumentBuilder` class contains methods for generating page content. To
|
|
164
|
-
customize the format:
|
|
165
|
-
|
|
166
|
-
1. Modify the `buildMainDocument()` method for changes to the main index page
|
|
167
|
-
2. Modify the `buildProjectDocument()` method for changes to project pages
|
|
168
|
-
3. Modify the `buildPolicySection()` and `buildRulesTable()` methods for changes
|
|
169
|
-
to policy and rule sections
|
|
170
|
-
|
|
171
|
-
## Conclusion
|
|
172
|
-
|
|
173
|
-
This documentation system ensures that Fawkes indexing rules are always
|
|
174
|
-
well-documented and accessible to the team. By automatically generating
|
|
175
|
-
documentation directly from the codebase, it eliminates the risk of
|
|
176
|
-
documentation becoming outdated or inconsistent with the actual implementation.
|
|
1
|
+
# fawkes
|
|
2
|
+
|
|
3
|
+
This project is used to centralize indexability logic for our Search
|
|
4
|
+
microservices and Sitemap Generator. The main purpose is to completely remove
|
|
5
|
+
discrepancies between pages indexed by Search and page URLs stored in Sitemap.
|
|
6
|
+
|
|
7
|
+
Link to documentation: https://studyportals.atlassian.net/wiki/x/BwAdvw
|
|
8
|
+
|
|
9
|
+
## Base structure
|
|
10
|
+
|
|
11
|
+
- organisations-seo (used by Organisation Search)
|
|
12
|
+
- scholarships-seo (used by Scholarship Search)
|
|
13
|
+
- sitemap-generator-seo (used by Sitemap Generator)
|
|
14
|
+
- src
|
|
15
|
+
- common
|
|
16
|
+
- organisations
|
|
17
|
+
- scholarships
|
|
18
|
+
- sitemap-generator
|
|
19
|
+
|
|
20
|
+
# Automatic Documentation System
|
|
21
|
+
|
|
22
|
+
## Overview
|
|
23
|
+
|
|
24
|
+
This system automatically generates and maintains documentation for Fawkes
|
|
25
|
+
indexing rules across multiple projects. It creates a hierarchical structure of
|
|
26
|
+
Confluence pages that document all indexing policies and rules, ensuring that
|
|
27
|
+
the documentation is always up-to-date with the actual codebase.
|
|
28
|
+
|
|
29
|
+
Link to documentation:
|
|
30
|
+
[Fawkes Indexing Rules Documentation](https://studyportals.atlassian.net/wiki/spaces/T/pages/3494969354/Fawkes+Indexing+Rules+Documentation)
|
|
31
|
+
|
|
32
|
+
## Features
|
|
33
|
+
|
|
34
|
+
- **Dynamic Documentation**: Automatically extracts indexing rules and policies
|
|
35
|
+
directly from the codebase
|
|
36
|
+
- **Multi-Page Structure**: Creates a main index page with separate pages for
|
|
37
|
+
each project
|
|
38
|
+
- **Hierarchical Organization**: Structures content as Projects → Policies →
|
|
39
|
+
Rules
|
|
40
|
+
- **Automatic Page Creation**: Intelligently creates or updates pages as needed
|
|
41
|
+
- **Cross-Page Navigation**: Provides intuitive navigation between all pages
|
|
42
|
+
|
|
43
|
+
## Architecture
|
|
44
|
+
|
|
45
|
+
The system follows SOLID design principles to ensure maintainability and
|
|
46
|
+
extensibility:
|
|
47
|
+
|
|
48
|
+
- **Single Responsibility**: Each class has one specific responsibility
|
|
49
|
+
- **Open/Closed**: Easily extendable without modifying existing code
|
|
50
|
+
- **Liskov Substitution**: Interchangeable components through well-defined
|
|
51
|
+
interfaces
|
|
52
|
+
- **Interface Segregation**: Clean, focused interfaces
|
|
53
|
+
- **Dependency Inversion**: High-level modules depend on abstractions
|
|
54
|
+
|
|
55
|
+
### Key Components
|
|
56
|
+
|
|
57
|
+
1. **Content Builder**: Extracts project, policy, and rule data from the Fawkes
|
|
58
|
+
system
|
|
59
|
+
2. **Policy Fetchers**: Project-specific components that fetch and format policy
|
|
60
|
+
data
|
|
61
|
+
3. **Document Builder**: Generates structured HTML content for Confluence pages
|
|
62
|
+
4. **Confluence Updater**: Handles creation and updating of Confluence pages
|
|
63
|
+
5. **Token Retriever**: Securely retrieves API token for Confluence access
|
|
64
|
+
|
|
65
|
+
## How It Works
|
|
66
|
+
|
|
67
|
+
1. The system starts by collecting all project data using the `ContentBuilder`
|
|
68
|
+
2. For each project, it extracts policies and rules using project-specific
|
|
69
|
+
fetchers
|
|
70
|
+
3. The `DocumentBuilder` generates the content for the main index page and each
|
|
71
|
+
project page
|
|
72
|
+
4. The `ConfluenceUpdater` creates or updates pages in Confluence as needed
|
|
73
|
+
5. Each project page links back to the main index, and the main index links to
|
|
74
|
+
all project pages
|
|
75
|
+
|
|
76
|
+
## Setup and Configuration
|
|
77
|
+
|
|
78
|
+
### Environment Variables
|
|
79
|
+
|
|
80
|
+
The system requires the following environment variables:
|
|
81
|
+
|
|
82
|
+
```
|
|
83
|
+
CONFLUENCE_EMAIL=your-email@example.com
|
|
84
|
+
CONFLUENCE_API_TOKEN=your-api-token
|
|
85
|
+
CONFLUENCE_BASE_URL=https://your-instance.atlassian.net
|
|
86
|
+
CONFLUENCE_SPACE_KEY=YOUR_SPACE_KEY
|
|
87
|
+
CONFLUENCE_MAIN_PAGE_TITLE=Fawkes Indexing Rules Documentation
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
> **Important Note on Credentials**: Currently, the system uses personal
|
|
91
|
+
> credentials (email and API token) for Confluence access. This is a temporary
|
|
92
|
+
> solution and should be replaced with a team or service account in the future
|
|
93
|
+
> to avoid dependency on a specific individual's account.
|
|
94
|
+
|
|
95
|
+
### Deployment and Triggering
|
|
96
|
+
|
|
97
|
+
The system runs as an AWS Lambda function and is automatically triggered as part
|
|
98
|
+
of the CI/CD pipeline. This ensures documentation is always updated whenever new
|
|
99
|
+
code is deployed:
|
|
100
|
+
|
|
101
|
+
```yaml
|
|
102
|
+
# buildspec.yml (excerpt)
|
|
103
|
+
post_build:
|
|
104
|
+
commands:
|
|
105
|
+
- |
|
|
106
|
+
if [ -z "$PR_ID" ]; then
|
|
107
|
+
LAMBDA_NAME="FawkesConfluenceUpdater-$STAGE"
|
|
108
|
+
echo "Invoking Lambda function $LAMBDA_NAME"
|
|
109
|
+
echo '{"source":"cicd-pipeline","timestamp":"'$(date -u +"%Y-%m-%dT%H:%M:%SZ")'"}' > payload.json
|
|
110
|
+
aws lambda invoke --function-name $LAMBDA_NAME --invocation-type Event --payload fileb://payload.json response.json || echo "Lambda invocation failed, but continuing"
|
|
111
|
+
fi
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
**Trigger Flow:**
|
|
115
|
+
|
|
116
|
+
1. When code is pushed to the `main` branch, the CI/CD pipeline is triggered
|
|
117
|
+
2. After successful deployment of a new Fawkes version, the post-build phase
|
|
118
|
+
executes
|
|
119
|
+
3. The Lambda function is invoked with a simple payload containing the source
|
|
120
|
+
and timestamp
|
|
121
|
+
4. The Lambda function authenticates with Confluence and executes the
|
|
122
|
+
documentation generation process
|
|
123
|
+
5. This only happens for production deployments (not PR builds)
|
|
124
|
+
|
|
125
|
+
This automated approach ensures documentation stays in sync with the actual
|
|
126
|
+
codebase without manual intervention.
|
|
127
|
+
|
|
128
|
+
## Scalability and Extension
|
|
129
|
+
|
|
130
|
+
### Adding New Projects
|
|
131
|
+
|
|
132
|
+
To add documentation for a new project:
|
|
133
|
+
|
|
134
|
+
1. Create a new class that implements the `IPolicyFetcher` interface
|
|
135
|
+
2. Implement the `getProjectName()` and `fetchPolicies()` methods
|
|
136
|
+
3. Register the new fetcher in the `ContentBuilder` constructor
|
|
137
|
+
|
|
138
|
+
Example:
|
|
139
|
+
|
|
140
|
+
```typescript
|
|
141
|
+
export class NewProjectPolicyFetcher implements IPolicyFetcher {
|
|
142
|
+
getProjectName(): string {
|
|
143
|
+
return 'New Project Name';
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
fetchPolicies(): IPolicy[] {
|
|
147
|
+
// Implement policy fetching logic
|
|
148
|
+
return [...policies];
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
// Then update ContentBuilder:
|
|
153
|
+
constructor(fetchers?: IPolicyFetcher[]) {
|
|
154
|
+
this.policyFetchers = fetchers || [
|
|
155
|
+
// Existing fetchers
|
|
156
|
+
new NewProjectPolicyFetcher()
|
|
157
|
+
];
|
|
158
|
+
}
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
### Customizing Page Content
|
|
162
|
+
|
|
163
|
+
The `DocumentBuilder` class contains methods for generating page content. To
|
|
164
|
+
customize the format:
|
|
165
|
+
|
|
166
|
+
1. Modify the `buildMainDocument()` method for changes to the main index page
|
|
167
|
+
2. Modify the `buildProjectDocument()` method for changes to project pages
|
|
168
|
+
3. Modify the `buildPolicySection()` and `buildRulesTable()` methods for changes
|
|
169
|
+
to policy and rule sections
|
|
170
|
+
|
|
171
|
+
## Conclusion
|
|
172
|
+
|
|
173
|
+
This documentation system ensures that Fawkes indexing rules are always
|
|
174
|
+
well-documented and accessible to the team. By automatically generating
|
|
175
|
+
documentation directly from the codebase, it eliminates the risk of
|
|
176
|
+
documentation becoming outdated or inconsistent with the actual implementation.
|
|
@@ -2,5 +2,5 @@ import { IFragment } from '../presenters/fragments/IFragment';
|
|
|
2
2
|
import { FilterKey } from '@studyportals/search-filters/server-side';
|
|
3
3
|
export interface IPresenter {
|
|
4
4
|
readonly filterKey: FilterKey;
|
|
5
|
-
getFragments(): IFragment[]
|
|
5
|
+
getFragments(): IFragment[] | Promise<IFragment[]>;
|
|
6
6
|
}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
export var AttendanceFilterOptionValue;
|
|
2
|
+
(function (AttendanceFilterOptionValue) {
|
|
3
|
+
AttendanceFilterOptionValue["FACE_2_FACE"] = "face2face";
|
|
4
|
+
AttendanceFilterOptionValue["ONLINE"] = "online";
|
|
5
|
+
AttendanceFilterOptionValue["BLENDED"] = "blended";
|
|
6
|
+
})(AttendanceFilterOptionValue || (AttendanceFilterOptionValue = {}));
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
export declare enum DegreeTypeFilterOptionValue {
|
|
2
|
+
PHD = "phd",
|
|
3
|
+
DBA = "dba",
|
|
4
|
+
DOCTORATE = "doct",
|
|
5
|
+
MSC = "msc",
|
|
6
|
+
MA = "ma",
|
|
7
|
+
MBA = "mba",
|
|
8
|
+
LLM = "llm",
|
|
9
|
+
MPHIL = "mphil",
|
|
10
|
+
MLITT = "mlitt",
|
|
11
|
+
MRES = "mres",
|
|
12
|
+
MED = "med",
|
|
13
|
+
MENG = "meng",
|
|
14
|
+
POSTGRADIP = "postgraddip",
|
|
15
|
+
POSTGRADCERT = "postgradcert",
|
|
16
|
+
PREMASTER = "premaster",
|
|
17
|
+
BSC = "bsc",
|
|
18
|
+
BA = "ba",
|
|
19
|
+
LLB = "llb",
|
|
20
|
+
BENG = "beng",
|
|
21
|
+
BBA = "bba",
|
|
22
|
+
ASSOCIATE_DEGREE = "ad",
|
|
23
|
+
ACADEMY_PROFESSION = "ap",
|
|
24
|
+
ADVANCED_DIPLOMA = "adiploma",
|
|
25
|
+
GRADUATE_CERTTIFICATE = "gcertificate",
|
|
26
|
+
GRADUATE_DIPLOMA = "gdiploma",
|
|
27
|
+
PREBACHELOR = "prebachelor",
|
|
28
|
+
CERTIFICATE = "certificate"
|
|
29
|
+
}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
export var DegreeTypeFilterOptionValue;
|
|
2
|
+
(function (DegreeTypeFilterOptionValue) {
|
|
3
|
+
DegreeTypeFilterOptionValue["PHD"] = "phd";
|
|
4
|
+
DegreeTypeFilterOptionValue["DBA"] = "dba";
|
|
5
|
+
DegreeTypeFilterOptionValue["DOCTORATE"] = "doct";
|
|
6
|
+
DegreeTypeFilterOptionValue["MSC"] = "msc";
|
|
7
|
+
DegreeTypeFilterOptionValue["MA"] = "ma";
|
|
8
|
+
DegreeTypeFilterOptionValue["MBA"] = "mba";
|
|
9
|
+
DegreeTypeFilterOptionValue["LLM"] = "llm";
|
|
10
|
+
DegreeTypeFilterOptionValue["MPHIL"] = "mphil";
|
|
11
|
+
DegreeTypeFilterOptionValue["MLITT"] = "mlitt";
|
|
12
|
+
DegreeTypeFilterOptionValue["MRES"] = "mres";
|
|
13
|
+
DegreeTypeFilterOptionValue["MED"] = "med";
|
|
14
|
+
DegreeTypeFilterOptionValue["MENG"] = "meng";
|
|
15
|
+
DegreeTypeFilterOptionValue["POSTGRADIP"] = "postgraddip";
|
|
16
|
+
DegreeTypeFilterOptionValue["POSTGRADCERT"] = "postgradcert";
|
|
17
|
+
DegreeTypeFilterOptionValue["PREMASTER"] = "premaster";
|
|
18
|
+
DegreeTypeFilterOptionValue["BSC"] = "bsc";
|
|
19
|
+
DegreeTypeFilterOptionValue["BA"] = "ba";
|
|
20
|
+
DegreeTypeFilterOptionValue["LLB"] = "llb";
|
|
21
|
+
DegreeTypeFilterOptionValue["BENG"] = "beng";
|
|
22
|
+
DegreeTypeFilterOptionValue["BBA"] = "bba";
|
|
23
|
+
DegreeTypeFilterOptionValue["ASSOCIATE_DEGREE"] = "ad";
|
|
24
|
+
DegreeTypeFilterOptionValue["ACADEMY_PROFESSION"] = "ap";
|
|
25
|
+
DegreeTypeFilterOptionValue["ADVANCED_DIPLOMA"] = "adiploma";
|
|
26
|
+
DegreeTypeFilterOptionValue["GRADUATE_CERTTIFICATE"] = "gcertificate";
|
|
27
|
+
DegreeTypeFilterOptionValue["GRADUATE_DIPLOMA"] = "gdiploma";
|
|
28
|
+
DegreeTypeFilterOptionValue["PREBACHELOR"] = "prebachelor";
|
|
29
|
+
DegreeTypeFilterOptionValue["CERTIFICATE"] = "certificate";
|
|
30
|
+
})(DegreeTypeFilterOptionValue || (DegreeTypeFilterOptionValue = {}));
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
export declare enum DurationFilterOptionValue {
|
|
2
|
+
LESS_THAN_ONE_MONTH = "[-1,29]",
|
|
3
|
+
ONE_TO_THREE_MONTHS = "[30,90]",
|
|
4
|
+
MORE_THAN_THREE_MONTHS = "[91,-1]",
|
|
5
|
+
LESS_THAN_ONE_YEAR = "[-1,359]",
|
|
6
|
+
ONE_YEAR = "[360,360]",
|
|
7
|
+
ONE_AND_A_HALF_YEARS = "[540,540]",
|
|
8
|
+
LESS_THAN_TWO_YEARS = "[-1,719]",
|
|
9
|
+
MORE_THAN_TWO_YEARS = "[721,-1]",
|
|
10
|
+
TWO_YEARS = "[720,720]",
|
|
11
|
+
TWO_AND_A_HALF_YEARS = "[900,900]",
|
|
12
|
+
THREE_YEARS = "[1080,1080]",
|
|
13
|
+
THREE_AND_A_HALF_YEARS = "[1260,1260]",
|
|
14
|
+
FOUR_YEARS = "[1440,1440]",
|
|
15
|
+
MORE_THAN_FOUR_YEARS = "[1441,-1]"
|
|
16
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
export var DurationFilterOptionValue;
|
|
2
|
+
(function (DurationFilterOptionValue) {
|
|
3
|
+
DurationFilterOptionValue["LESS_THAN_ONE_MONTH"] = "[-1,29]";
|
|
4
|
+
DurationFilterOptionValue["ONE_TO_THREE_MONTHS"] = "[30,90]";
|
|
5
|
+
DurationFilterOptionValue["MORE_THAN_THREE_MONTHS"] = "[91,-1]";
|
|
6
|
+
DurationFilterOptionValue["LESS_THAN_ONE_YEAR"] = "[-1,359]";
|
|
7
|
+
DurationFilterOptionValue["ONE_YEAR"] = "[360,360]";
|
|
8
|
+
DurationFilterOptionValue["ONE_AND_A_HALF_YEARS"] = "[540,540]";
|
|
9
|
+
DurationFilterOptionValue["LESS_THAN_TWO_YEARS"] = "[-1,719]";
|
|
10
|
+
DurationFilterOptionValue["MORE_THAN_TWO_YEARS"] = "[721,-1]";
|
|
11
|
+
DurationFilterOptionValue["TWO_YEARS"] = "[720,720]";
|
|
12
|
+
DurationFilterOptionValue["TWO_AND_A_HALF_YEARS"] = "[900,900]";
|
|
13
|
+
DurationFilterOptionValue["THREE_YEARS"] = "[1080,1080]";
|
|
14
|
+
DurationFilterOptionValue["THREE_AND_A_HALF_YEARS"] = "[1260,1260]";
|
|
15
|
+
DurationFilterOptionValue["FOUR_YEARS"] = "[1440,1440]";
|
|
16
|
+
DurationFilterOptionValue["MORE_THAN_FOUR_YEARS"] = "[1441,-1]";
|
|
17
|
+
})(DurationFilterOptionValue || (DurationFilterOptionValue = {}));
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export declare enum EducationalFormFilterOptionValue {
|
|
2
|
+
ACADEMIC_COURSE = "academic",
|
|
3
|
+
CONFERENCE_SEMINAR = "conference",
|
|
4
|
+
SUMMER_SCHOOL = "summer_school",
|
|
5
|
+
WINTER_SCHOOL = "winter_school",
|
|
6
|
+
SEMESTER_STUDY_ABROAD = "semester",
|
|
7
|
+
SKILL_PROFESSIONAL_COURSE = "skill"
|
|
8
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
export var EducationalFormFilterOptionValue;
|
|
2
|
+
(function (EducationalFormFilterOptionValue) {
|
|
3
|
+
EducationalFormFilterOptionValue["ACADEMIC_COURSE"] = "academic";
|
|
4
|
+
EducationalFormFilterOptionValue["CONFERENCE_SEMINAR"] = "conference";
|
|
5
|
+
EducationalFormFilterOptionValue["SUMMER_SCHOOL"] = "summer_school";
|
|
6
|
+
EducationalFormFilterOptionValue["WINTER_SCHOOL"] = "winter_school";
|
|
7
|
+
EducationalFormFilterOptionValue["SEMESTER_STUDY_ABROAD"] = "semester";
|
|
8
|
+
EducationalFormFilterOptionValue["SKILL_PROFESSIONAL_COURSE"] = "skill";
|
|
9
|
+
})(EducationalFormFilterOptionValue || (EducationalFormFilterOptionValue = {}));
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
export declare enum FilterKey {
|
|
2
|
+
KEYWORD_WHAT = "kw-what",
|
|
3
|
+
KEYWORD_WHERE = "kw-where",
|
|
4
|
+
KEYWORD = "kw",
|
|
5
|
+
ORGANISATIONS = "oi",
|
|
6
|
+
DISCIPLINES = "di",
|
|
7
|
+
EDUCATION_LEVEL = "lv",
|
|
8
|
+
CONTINENT = "rg",
|
|
9
|
+
COUNTRY = "ci",
|
|
10
|
+
AREA = "ae",
|
|
11
|
+
TUITION_FEE = "tr",
|
|
12
|
+
DURATION = "dur",
|
|
13
|
+
ATTENDANCE = "de",
|
|
14
|
+
DELIVERY_METHOD = "mh",
|
|
15
|
+
DEGREE_TYPE = "dg",
|
|
16
|
+
EDUCATIONAL_FORM = "ef",
|
|
17
|
+
SPECIAL_PROGRAMMES = "sps",
|
|
18
|
+
USER_COUNTRY = "uc",
|
|
19
|
+
USER_REGION = "ur",
|
|
20
|
+
CURRENCY = "tc"
|
|
21
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
export var FilterKey;
|
|
2
|
+
(function (FilterKey) {
|
|
3
|
+
FilterKey["KEYWORD_WHAT"] = "kw-what";
|
|
4
|
+
FilterKey["KEYWORD_WHERE"] = "kw-where";
|
|
5
|
+
FilterKey["KEYWORD"] = "kw";
|
|
6
|
+
FilterKey["ORGANISATIONS"] = "oi";
|
|
7
|
+
FilterKey["DISCIPLINES"] = "di";
|
|
8
|
+
FilterKey["EDUCATION_LEVEL"] = "lv";
|
|
9
|
+
FilterKey["CONTINENT"] = "rg";
|
|
10
|
+
FilterKey["COUNTRY"] = "ci";
|
|
11
|
+
FilterKey["AREA"] = "ae";
|
|
12
|
+
FilterKey["TUITION_FEE"] = "tr";
|
|
13
|
+
FilterKey["DURATION"] = "dur";
|
|
14
|
+
FilterKey["ATTENDANCE"] = "de";
|
|
15
|
+
FilterKey["DELIVERY_METHOD"] = "mh";
|
|
16
|
+
FilterKey["DEGREE_TYPE"] = "dg";
|
|
17
|
+
FilterKey["EDUCATIONAL_FORM"] = "ef";
|
|
18
|
+
FilterKey["SPECIAL_PROGRAMMES"] = "sps";
|
|
19
|
+
FilterKey["USER_COUNTRY"] = "uc";
|
|
20
|
+
FilterKey["USER_REGION"] = "ur";
|
|
21
|
+
FilterKey["CURRENCY"] = "tc";
|
|
22
|
+
})(FilterKey || (FilterKey = {}));
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
export var SpecialProgrammesFilterOptionValue;
|
|
2
|
+
(function (SpecialProgrammesFilterOptionValue) {
|
|
3
|
+
SpecialProgrammesFilterOptionValue["EXECUTIVE_PROGRAMMES"] = "executive";
|
|
4
|
+
SpecialProgrammesFilterOptionValue["JOINT_PROGRAMMES"] = "joint";
|
|
5
|
+
SpecialProgrammesFilterOptionValue["ERASMUS_MUNDUS"] = "erasmus";
|
|
6
|
+
})(SpecialProgrammesFilterOptionValue || (SpecialProgrammesFilterOptionValue = {}));
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { DependencyTypes } from '../enums/DependencyTypes';
|
|
2
|
-
import { Area, AreaAttendance, Attendance, Continent, Country, CountryAttendance, Unfiltered, RankedArea, RankedAreaDiscipline, RankedAttendance, RankedAttendanceDiscipline, RankedContinent, RankedContinentAttendance, RankedCountry, RankedCountryAttendance, RankedCountryDiscipline, RankedDiscipline, RankedUnfiltered } from '../organisations/policies';
|
|
2
|
+
import { City, Area, AreaAttendance, Attendance, Continent, Country, CountryAttendance, Unfiltered, RankedArea, RankedAreaDiscipline, RankedAttendance, RankedAttendanceDiscipline, RankedContinent, RankedContinentAttendance, RankedCountry, RankedCountryAttendance, RankedCountryDiscipline, RankedDiscipline, RankedUnfiltered } from '../organisations/policies';
|
|
3
3
|
export class SearchIndexabilityManager {
|
|
4
4
|
policies;
|
|
5
5
|
constructor(portalType, seoInfoBase, filterState, sortingState, applicationState) {
|
|
@@ -12,6 +12,7 @@ export class SearchIndexabilityManager {
|
|
|
12
12
|
portalType
|
|
13
13
|
};
|
|
14
14
|
this.policies = [
|
|
15
|
+
new City(dependencies),
|
|
15
16
|
new Area(dependencies),
|
|
16
17
|
new AreaAttendance(dependencies),
|
|
17
18
|
new Attendance(dependencies),
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { FilterCombinations } from '../../../enums/FilterCombinations';
|
|
2
|
+
import { SortingOptions } from '../../../enums/SortingOptions';
|
|
3
|
+
import { OrganisationsSeoIndexabilityPolicy } from '../../../organisations/policies/OrganisationsSeoIndexabilityPolicy';
|
|
4
|
+
import { OnlyFullLocationFiltersSelectedRule } from '../../../organisations/rules/OnlyFullLocationFiltersSelectedRule';
|
|
5
|
+
export declare class City extends OrganisationsSeoIndexabilityPolicy {
|
|
6
|
+
readonly name: string;
|
|
7
|
+
readonly description: string;
|
|
8
|
+
protected readonly sortingOption = SortingOptions.OUR_PICKS;
|
|
9
|
+
protected readonly baseRules: OnlyFullLocationFiltersSelectedRule[];
|
|
10
|
+
protected generateUrls(): Promise<string[]>;
|
|
11
|
+
get filterCombination(): FilterCombinations;
|
|
12
|
+
}
|