@ndla/types-backend 0.2.101 → 1.0.2
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/build/article-api.d.ts +40 -50
- package/build/audio-api.d.ts +53 -53
- package/build/concept-api.d.ts +62 -72
- package/build/draft-api.d.ts +80 -80
- package/build/frontpage-api.d.ts +39 -39
- package/build/image-api.d.ts +51 -61
- package/build/image-api.js.map +1 -1
- package/build/learningpath-api.d.ts +44 -44
- package/build/myndla-api.d.ts +63 -63
- package/build/search-api.d.ts +75 -76
- package/build/search-api.js.map +1 -1
- package/package.json +1 -1
package/build/myndla-api.d.ts
CHANGED
|
@@ -1,16 +1,20 @@
|
|
|
1
1
|
export type ArenaGroup = "ADMIN";
|
|
2
|
-
export interface
|
|
2
|
+
export interface IArenaUserDTO {
|
|
3
3
|
id: number;
|
|
4
4
|
displayName: string;
|
|
5
5
|
username: string;
|
|
6
6
|
location: string;
|
|
7
7
|
groups: ArenaGroup[];
|
|
8
8
|
}
|
|
9
|
-
export interface
|
|
9
|
+
export interface IBreadcrumbDTO {
|
|
10
10
|
id: string;
|
|
11
11
|
name: string;
|
|
12
12
|
}
|
|
13
|
-
export interface
|
|
13
|
+
export interface ICategoryBreadcrumbDTO {
|
|
14
|
+
id: number;
|
|
15
|
+
title: string;
|
|
16
|
+
}
|
|
17
|
+
export interface ICategoryDTO {
|
|
14
18
|
id: number;
|
|
15
19
|
title: string;
|
|
16
20
|
description: string;
|
|
@@ -21,14 +25,10 @@ export interface ICategory {
|
|
|
21
25
|
rank: number;
|
|
22
26
|
parentCategoryId?: number;
|
|
23
27
|
categoryCount: number;
|
|
24
|
-
subcategories:
|
|
25
|
-
breadcrumbs:
|
|
26
|
-
}
|
|
27
|
-
export interface ICategoryBreadcrumb {
|
|
28
|
-
id: number;
|
|
29
|
-
title: string;
|
|
28
|
+
subcategories: ICategoryDTO[];
|
|
29
|
+
breadcrumbs: ICategoryBreadcrumbDTO[];
|
|
30
30
|
}
|
|
31
|
-
export interface
|
|
31
|
+
export interface ICategoryWithTopicsDTO {
|
|
32
32
|
id: number;
|
|
33
33
|
title: string;
|
|
34
34
|
description: string;
|
|
@@ -36,56 +36,56 @@ export interface ICategoryWithTopics {
|
|
|
36
36
|
postCount: number;
|
|
37
37
|
topicPage: number;
|
|
38
38
|
topicPageSize: number;
|
|
39
|
-
topics:
|
|
39
|
+
topics: ITopicDTO[];
|
|
40
40
|
isFollowing: boolean;
|
|
41
41
|
visible: boolean;
|
|
42
42
|
rank: number;
|
|
43
43
|
parentCategoryId?: number;
|
|
44
44
|
categoryCount: number;
|
|
45
|
-
subcategories:
|
|
46
|
-
breadcrumbs:
|
|
45
|
+
subcategories: ICategoryDTO[];
|
|
46
|
+
breadcrumbs: ICategoryBreadcrumbDTO[];
|
|
47
47
|
}
|
|
48
|
-
export interface
|
|
48
|
+
export interface IConfigMetaDTO {
|
|
49
49
|
key: string;
|
|
50
50
|
value: (boolean | string[]);
|
|
51
51
|
updatedAt: string;
|
|
52
52
|
updatedBy: string;
|
|
53
53
|
}
|
|
54
|
-
export interface
|
|
54
|
+
export interface IConfigMetaRestrictedDTO {
|
|
55
55
|
key: string;
|
|
56
56
|
value: (boolean | string[]);
|
|
57
57
|
}
|
|
58
|
-
export interface
|
|
58
|
+
export interface IFlagDTO {
|
|
59
59
|
id: number;
|
|
60
60
|
reason: string;
|
|
61
61
|
created: string;
|
|
62
62
|
resolved?: string;
|
|
63
63
|
isResolved: boolean;
|
|
64
|
-
flagger?:
|
|
64
|
+
flagger?: IArenaUserDTO;
|
|
65
65
|
}
|
|
66
|
-
export interface
|
|
66
|
+
export interface IFolderDTO {
|
|
67
67
|
id: string;
|
|
68
68
|
name: string;
|
|
69
69
|
status: string;
|
|
70
70
|
parentId?: string;
|
|
71
|
-
breadcrumbs:
|
|
72
|
-
subfolders:
|
|
73
|
-
resources:
|
|
71
|
+
breadcrumbs: IBreadcrumbDTO[];
|
|
72
|
+
subfolders: IFolderDataDTO[];
|
|
73
|
+
resources: IResourceDTO[];
|
|
74
74
|
rank: number;
|
|
75
75
|
created: string;
|
|
76
76
|
updated: string;
|
|
77
77
|
shared?: string;
|
|
78
78
|
description?: string;
|
|
79
|
-
owner?:
|
|
79
|
+
owner?: IOwnerDTO;
|
|
80
80
|
}
|
|
81
|
-
export type
|
|
82
|
-
export interface
|
|
81
|
+
export type IFolderDataDTO = IFolderDTO;
|
|
82
|
+
export interface IMyNDLAGroupDTO {
|
|
83
83
|
id: string;
|
|
84
84
|
displayName: string;
|
|
85
85
|
isPrimarySchool: boolean;
|
|
86
86
|
parentId?: string;
|
|
87
87
|
}
|
|
88
|
-
export interface
|
|
88
|
+
export interface IMyNDLAUserDTO {
|
|
89
89
|
id: number;
|
|
90
90
|
feideId: string;
|
|
91
91
|
username: string;
|
|
@@ -94,91 +94,91 @@ export interface IMyNDLAUser {
|
|
|
94
94
|
favoriteSubjects: string[];
|
|
95
95
|
role: string;
|
|
96
96
|
organization: string;
|
|
97
|
-
groups:
|
|
97
|
+
groups: IMyNDLAGroupDTO[];
|
|
98
98
|
arenaEnabled: boolean;
|
|
99
99
|
shareName: boolean;
|
|
100
100
|
arenaGroups: ArenaGroup[];
|
|
101
101
|
}
|
|
102
|
-
export interface
|
|
102
|
+
export interface INewCategoryDTO {
|
|
103
103
|
title: string;
|
|
104
104
|
description: string;
|
|
105
105
|
visible: boolean;
|
|
106
106
|
parentCategoryId?: number;
|
|
107
107
|
}
|
|
108
|
-
export interface
|
|
108
|
+
export interface INewFlagDTO {
|
|
109
109
|
reason: string;
|
|
110
110
|
}
|
|
111
|
-
export interface
|
|
111
|
+
export interface INewFolderDTO {
|
|
112
112
|
name: string;
|
|
113
113
|
parentId?: string;
|
|
114
114
|
status?: string;
|
|
115
115
|
description?: string;
|
|
116
116
|
}
|
|
117
|
-
export interface
|
|
117
|
+
export interface INewPostDTO {
|
|
118
118
|
content: string;
|
|
119
119
|
toPostId?: number;
|
|
120
120
|
}
|
|
121
|
-
export interface
|
|
121
|
+
export interface INewPostNotificationDTO {
|
|
122
122
|
id: number;
|
|
123
123
|
topicId: number;
|
|
124
124
|
isRead: boolean;
|
|
125
125
|
topicTitle: string;
|
|
126
|
-
post:
|
|
126
|
+
post: IPostDTO;
|
|
127
127
|
notificationTime: string;
|
|
128
128
|
}
|
|
129
|
-
export interface
|
|
129
|
+
export interface INewResourceDTO {
|
|
130
130
|
resourceType: ResourceType;
|
|
131
131
|
path: string;
|
|
132
132
|
tags?: string[];
|
|
133
133
|
resourceId: string;
|
|
134
134
|
}
|
|
135
|
-
export interface
|
|
135
|
+
export interface INewTopicDTO {
|
|
136
136
|
title: string;
|
|
137
|
-
initialPost:
|
|
137
|
+
initialPost: INewPostDTO;
|
|
138
138
|
isLocked?: boolean;
|
|
139
139
|
isPinned?: boolean;
|
|
140
140
|
}
|
|
141
|
-
export interface
|
|
141
|
+
export interface IOwnerDTO {
|
|
142
142
|
name: string;
|
|
143
143
|
}
|
|
144
|
-
export interface
|
|
144
|
+
export interface IPaginatedArenaUsersDTO {
|
|
145
145
|
totalCount: number;
|
|
146
146
|
page: number;
|
|
147
147
|
pageSize: number;
|
|
148
|
-
items:
|
|
148
|
+
items: IArenaUserDTO[];
|
|
149
149
|
}
|
|
150
|
-
export interface
|
|
150
|
+
export interface IPaginatedNewPostNotificationsDTO {
|
|
151
151
|
totalCount: number;
|
|
152
152
|
page: number;
|
|
153
153
|
pageSize: number;
|
|
154
|
-
items:
|
|
154
|
+
items: INewPostNotificationDTO[];
|
|
155
155
|
}
|
|
156
|
-
export interface
|
|
156
|
+
export interface IPaginatedPostsDTO {
|
|
157
157
|
totalCount: number;
|
|
158
158
|
page: number;
|
|
159
159
|
pageSize: number;
|
|
160
|
-
items:
|
|
160
|
+
items: IPostDTO[];
|
|
161
161
|
}
|
|
162
|
-
export interface
|
|
162
|
+
export interface IPaginatedTopicsDTO {
|
|
163
163
|
totalCount: number;
|
|
164
164
|
page: number;
|
|
165
165
|
pageSize: number;
|
|
166
|
-
items:
|
|
166
|
+
items: ITopicDTO[];
|
|
167
167
|
}
|
|
168
|
-
export interface
|
|
168
|
+
export interface IPostDTO {
|
|
169
169
|
id: number;
|
|
170
170
|
content: string;
|
|
171
171
|
created: string;
|
|
172
172
|
updated: string;
|
|
173
|
-
owner?:
|
|
174
|
-
flags?:
|
|
173
|
+
owner?: IArenaUserDTO;
|
|
174
|
+
flags?: IFlagDTO[];
|
|
175
175
|
topicId: number;
|
|
176
|
-
replies:
|
|
176
|
+
replies: IPostWrapperDTO[];
|
|
177
177
|
upvotes: number;
|
|
178
178
|
upvoted: boolean;
|
|
179
179
|
}
|
|
180
|
-
export type
|
|
181
|
-
export interface
|
|
180
|
+
export type IPostWrapperDTO = IPostDTO;
|
|
181
|
+
export interface IResourceDTO {
|
|
182
182
|
id: string;
|
|
183
183
|
resourceType: ResourceType;
|
|
184
184
|
path: string;
|
|
@@ -187,27 +187,27 @@ export interface IResource {
|
|
|
187
187
|
resourceId: string;
|
|
188
188
|
rank?: number;
|
|
189
189
|
}
|
|
190
|
-
export interface
|
|
190
|
+
export interface IResourceStatsDTO {
|
|
191
191
|
type: string;
|
|
192
192
|
number: number;
|
|
193
193
|
}
|
|
194
|
-
export interface
|
|
194
|
+
export interface ISingleResourceStatsDTO {
|
|
195
195
|
id: string;
|
|
196
196
|
favourites: number;
|
|
197
197
|
}
|
|
198
|
-
export interface
|
|
198
|
+
export interface IStatsDTO {
|
|
199
199
|
numberOfUsers: number;
|
|
200
200
|
numberOfFolders: number;
|
|
201
201
|
numberOfResources: number;
|
|
202
202
|
numberOfTags: number;
|
|
203
203
|
numberOfSubjects: number;
|
|
204
204
|
numberOfSharedFolders: number;
|
|
205
|
-
favouritedResources:
|
|
205
|
+
favouritedResources: IResourceStatsDTO[];
|
|
206
206
|
favourited: {
|
|
207
207
|
[key: string]: number;
|
|
208
208
|
};
|
|
209
209
|
}
|
|
210
|
-
export interface
|
|
210
|
+
export interface ITopicDTO {
|
|
211
211
|
id: number;
|
|
212
212
|
title: string;
|
|
213
213
|
postCount: number;
|
|
@@ -219,11 +219,11 @@ export interface ITopic {
|
|
|
219
219
|
isPinned: boolean;
|
|
220
220
|
voteCount: number;
|
|
221
221
|
}
|
|
222
|
-
export interface
|
|
222
|
+
export interface ITopicWithPostsDTO {
|
|
223
223
|
id: number;
|
|
224
224
|
title: string;
|
|
225
225
|
postCount: number;
|
|
226
|
-
posts:
|
|
226
|
+
posts: IPaginatedPostsDTO;
|
|
227
227
|
created: string;
|
|
228
228
|
updated: string;
|
|
229
229
|
categoryId: number;
|
|
@@ -232,23 +232,23 @@ export interface ITopicWithPosts {
|
|
|
232
232
|
isPinned: boolean;
|
|
233
233
|
voteCount: number;
|
|
234
234
|
}
|
|
235
|
-
export interface
|
|
235
|
+
export interface IUpdatedFolderDTO {
|
|
236
236
|
name?: string;
|
|
237
237
|
status?: string;
|
|
238
238
|
description?: string;
|
|
239
239
|
}
|
|
240
|
-
export interface
|
|
240
|
+
export interface IUpdatedMyNDLAUserDTO {
|
|
241
241
|
favoriteSubjects?: string[];
|
|
242
242
|
arenaEnabled?: boolean;
|
|
243
243
|
shareName?: boolean;
|
|
244
244
|
arenaGroups?: ArenaGroup[];
|
|
245
245
|
}
|
|
246
|
-
export interface
|
|
246
|
+
export interface IUpdatedResourceDTO {
|
|
247
247
|
tags?: string[];
|
|
248
248
|
resourceId?: string;
|
|
249
249
|
}
|
|
250
|
-
export interface
|
|
251
|
-
folders:
|
|
252
|
-
sharedFolders:
|
|
250
|
+
export interface IUserFolderDTO {
|
|
251
|
+
folders: IFolderDTO[];
|
|
252
|
+
sharedFolders: IFolderDTO[];
|
|
253
253
|
}
|
|
254
254
|
export type ResourceType = ("article" | "audio" | "concept" | "image" | "learningpath" | "multidisciplinary" | "topic" | "video");
|
package/build/search-api.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
export type GrepSort = ("-relevance" | "relevance" | "-title" | "title" | "-code" | "code");
|
|
2
|
-
export interface
|
|
2
|
+
export interface IApiTaxonomyContextDTO {
|
|
3
3
|
publicId: string;
|
|
4
4
|
root: string;
|
|
5
5
|
rootId: string;
|
|
@@ -9,47 +9,47 @@ export interface IApiTaxonomyContext {
|
|
|
9
9
|
breadcrumbs: string[];
|
|
10
10
|
contextId: string;
|
|
11
11
|
contextType: string;
|
|
12
|
-
resourceTypes:
|
|
12
|
+
resourceTypes: ITaxonomyResourceTypeDTO[];
|
|
13
13
|
language: string;
|
|
14
14
|
isPrimary: boolean;
|
|
15
15
|
isActive: boolean;
|
|
16
16
|
url: string;
|
|
17
17
|
}
|
|
18
|
-
export interface
|
|
18
|
+
export interface IArticleIntroductionDTO {
|
|
19
19
|
introduction: string;
|
|
20
20
|
htmlIntroduction: string;
|
|
21
21
|
language: string;
|
|
22
22
|
}
|
|
23
|
-
export interface
|
|
23
|
+
export interface IArticleResultDTO {
|
|
24
24
|
id: number;
|
|
25
|
-
title:
|
|
26
|
-
introduction?:
|
|
25
|
+
title: ITitleWithHtmlDTO;
|
|
26
|
+
introduction?: IArticleIntroductionDTO;
|
|
27
27
|
articleType: string;
|
|
28
28
|
supportedLanguages: string[];
|
|
29
29
|
}
|
|
30
|
-
export interface
|
|
30
|
+
export interface IArticleResultsDTO {
|
|
31
31
|
type: string;
|
|
32
32
|
language: string;
|
|
33
33
|
totalCount: number;
|
|
34
34
|
page: number;
|
|
35
35
|
pageSize: number;
|
|
36
|
-
results:
|
|
36
|
+
results: IArticleResultDTO[];
|
|
37
37
|
}
|
|
38
|
-
export interface
|
|
38
|
+
export interface IAudioResultDTO {
|
|
39
39
|
id: number;
|
|
40
|
-
title:
|
|
40
|
+
title: ITitleDTO;
|
|
41
41
|
url: string;
|
|
42
42
|
supportedLanguages: string[];
|
|
43
43
|
}
|
|
44
|
-
export interface
|
|
44
|
+
export interface IAudioResultsDTO {
|
|
45
45
|
type: string;
|
|
46
46
|
language: string;
|
|
47
47
|
totalCount: number;
|
|
48
48
|
page: number;
|
|
49
49
|
pageSize: number;
|
|
50
|
-
results:
|
|
50
|
+
results: IAudioResultDTO[];
|
|
51
51
|
}
|
|
52
|
-
export interface
|
|
52
|
+
export interface ICommentDTO {
|
|
53
53
|
id: string;
|
|
54
54
|
content: string;
|
|
55
55
|
created: string;
|
|
@@ -57,11 +57,11 @@ export interface IComment {
|
|
|
57
57
|
isOpen: boolean;
|
|
58
58
|
solved: boolean;
|
|
59
59
|
}
|
|
60
|
-
export interface
|
|
60
|
+
export interface IDraftResponsibleDTO {
|
|
61
61
|
responsibleId: string;
|
|
62
62
|
lastUpdated: string;
|
|
63
63
|
}
|
|
64
|
-
export interface
|
|
64
|
+
export interface IDraftSearchParamsDTO {
|
|
65
65
|
page?: number;
|
|
66
66
|
pageSize?: number;
|
|
67
67
|
articleTypes?: string[];
|
|
@@ -81,6 +81,7 @@ export interface IDraftSearchParams {
|
|
|
81
81
|
draftStatus?: string[];
|
|
82
82
|
users?: string[];
|
|
83
83
|
grepCodes?: string[];
|
|
84
|
+
traits?: SearchTrait[];
|
|
84
85
|
aggregatePaths?: string[];
|
|
85
86
|
embedResource?: string[];
|
|
86
87
|
embedId?: string;
|
|
@@ -97,11 +98,11 @@ export interface IDraftSearchParams {
|
|
|
97
98
|
publishedDateTo?: string;
|
|
98
99
|
resultTypes?: SearchType[];
|
|
99
100
|
}
|
|
100
|
-
export interface
|
|
101
|
+
export interface IGrepResultDTO {
|
|
101
102
|
code: string;
|
|
102
|
-
title:
|
|
103
|
+
title: ITitleDTO;
|
|
103
104
|
}
|
|
104
|
-
export interface
|
|
105
|
+
export interface IGrepSearchInputDTO {
|
|
105
106
|
prefixFilter?: string[];
|
|
106
107
|
codes?: string[];
|
|
107
108
|
query?: string;
|
|
@@ -110,106 +111,106 @@ export interface IGrepSearchInput {
|
|
|
110
111
|
sort?: GrepSort;
|
|
111
112
|
language?: string;
|
|
112
113
|
}
|
|
113
|
-
export interface
|
|
114
|
+
export interface IGrepSearchResultsDTO {
|
|
114
115
|
totalCount: number;
|
|
115
116
|
page: number;
|
|
116
117
|
pageSize: number;
|
|
117
118
|
language: string;
|
|
118
|
-
results:
|
|
119
|
+
results: IGrepResultDTO[];
|
|
119
120
|
}
|
|
120
|
-
export interface
|
|
121
|
+
export interface IGroupSearchResultDTO {
|
|
121
122
|
totalCount: number;
|
|
122
123
|
page?: number;
|
|
123
124
|
pageSize: number;
|
|
124
125
|
language: string;
|
|
125
|
-
results:
|
|
126
|
-
suggestions:
|
|
127
|
-
aggregations:
|
|
126
|
+
results: IMultiSearchSummaryDTO[];
|
|
127
|
+
suggestions: IMultiSearchSuggestionDTO[];
|
|
128
|
+
aggregations: IMultiSearchTermsAggregationDTO[];
|
|
128
129
|
resourceType: string;
|
|
129
130
|
}
|
|
130
|
-
export interface
|
|
131
|
+
export interface IHighlightedFieldDTO {
|
|
131
132
|
field: string;
|
|
132
133
|
matches: string[];
|
|
133
134
|
}
|
|
134
|
-
export interface
|
|
135
|
+
export interface IImageAltTextDTO {
|
|
135
136
|
altText: string;
|
|
136
137
|
language: string;
|
|
137
138
|
}
|
|
138
|
-
export interface
|
|
139
|
+
export interface IImageResultDTO {
|
|
139
140
|
id: number;
|
|
140
|
-
title:
|
|
141
|
-
altText:
|
|
141
|
+
title: ITitleDTO;
|
|
142
|
+
altText: IImageAltTextDTO;
|
|
142
143
|
previewUrl: string;
|
|
143
144
|
metaUrl: string;
|
|
144
145
|
supportedLanguages: string[];
|
|
145
146
|
}
|
|
146
|
-
export interface
|
|
147
|
+
export interface IImageResultsDTO {
|
|
147
148
|
type: string;
|
|
148
149
|
language: string;
|
|
149
150
|
totalCount: number;
|
|
150
151
|
page: number;
|
|
151
152
|
pageSize: number;
|
|
152
|
-
results:
|
|
153
|
+
results: IImageResultDTO[];
|
|
153
154
|
}
|
|
154
|
-
export interface
|
|
155
|
+
export interface ILearningPathIntroductionDTO {
|
|
155
156
|
introduction: string;
|
|
156
157
|
language: string;
|
|
157
158
|
}
|
|
158
|
-
export interface
|
|
159
|
+
export interface ILearningpathResultDTO {
|
|
159
160
|
id: number;
|
|
160
|
-
title:
|
|
161
|
-
introduction:
|
|
161
|
+
title: ITitleDTO;
|
|
162
|
+
introduction: ILearningPathIntroductionDTO;
|
|
162
163
|
supportedLanguages: string[];
|
|
163
164
|
}
|
|
164
|
-
export interface
|
|
165
|
+
export interface ILearningpathResultsDTO {
|
|
165
166
|
type: string;
|
|
166
167
|
language: string;
|
|
167
168
|
totalCount: number;
|
|
168
169
|
page: number;
|
|
169
170
|
pageSize: number;
|
|
170
|
-
results:
|
|
171
|
+
results: ILearningpathResultDTO[];
|
|
171
172
|
}
|
|
172
|
-
export interface
|
|
173
|
+
export interface IMetaDescriptionDTO {
|
|
173
174
|
metaDescription: string;
|
|
174
175
|
language: string;
|
|
175
176
|
}
|
|
176
|
-
export interface
|
|
177
|
+
export interface IMetaImageDTO {
|
|
177
178
|
url: string;
|
|
178
179
|
alt: string;
|
|
179
180
|
language: string;
|
|
180
181
|
}
|
|
181
|
-
export interface
|
|
182
|
+
export interface IMultiSearchResultDTO {
|
|
182
183
|
totalCount: number;
|
|
183
184
|
page?: number;
|
|
184
185
|
pageSize: number;
|
|
185
186
|
language: string;
|
|
186
|
-
results:
|
|
187
|
-
suggestions:
|
|
188
|
-
aggregations:
|
|
187
|
+
results: IMultiSearchSummaryDTO[];
|
|
188
|
+
suggestions: IMultiSearchSuggestionDTO[];
|
|
189
|
+
aggregations: IMultiSearchTermsAggregationDTO[];
|
|
189
190
|
}
|
|
190
|
-
export interface
|
|
191
|
+
export interface IMultiSearchSuggestionDTO {
|
|
191
192
|
name: string;
|
|
192
|
-
suggestions:
|
|
193
|
+
suggestions: ISearchSuggestionDTO[];
|
|
193
194
|
}
|
|
194
|
-
export interface
|
|
195
|
+
export interface IMultiSearchSummaryDTO {
|
|
195
196
|
id: number;
|
|
196
|
-
title:
|
|
197
|
-
metaDescription:
|
|
198
|
-
metaImage?:
|
|
197
|
+
title: ITitleWithHtmlDTO;
|
|
198
|
+
metaDescription: IMetaDescriptionDTO;
|
|
199
|
+
metaImage?: IMetaImageDTO;
|
|
199
200
|
url: string;
|
|
200
|
-
contexts:
|
|
201
|
+
contexts: IApiTaxonomyContextDTO[];
|
|
201
202
|
supportedLanguages: string[];
|
|
202
203
|
learningResourceType: LearningResourceType;
|
|
203
|
-
status?:
|
|
204
|
-
traits:
|
|
204
|
+
status?: IStatusDTO;
|
|
205
|
+
traits: SearchTrait[];
|
|
205
206
|
score: number;
|
|
206
|
-
highlights:
|
|
207
|
+
highlights: IHighlightedFieldDTO[];
|
|
207
208
|
paths: string[];
|
|
208
209
|
lastUpdated: string;
|
|
209
210
|
license?: string;
|
|
210
|
-
revisions:
|
|
211
|
-
responsible?:
|
|
212
|
-
comments?:
|
|
211
|
+
revisions: IRevisionMetaDTO[];
|
|
212
|
+
responsible?: IDraftResponsibleDTO;
|
|
213
|
+
comments?: ICommentDTO[];
|
|
213
214
|
prioritized?: boolean;
|
|
214
215
|
priority?: string;
|
|
215
216
|
resourceTypeName?: string;
|
|
@@ -220,22 +221,18 @@ export interface IMultiSearchSummary {
|
|
|
220
221
|
resultType: SearchType;
|
|
221
222
|
conceptSubjectIds?: string[];
|
|
222
223
|
}
|
|
223
|
-
export interface
|
|
224
|
+
export interface IMultiSearchTermsAggregationDTO {
|
|
224
225
|
field: string;
|
|
225
226
|
sumOtherDocCount: number;
|
|
226
227
|
docCountErrorUpperBound: number;
|
|
227
|
-
values:
|
|
228
|
+
values: ITermValueDTO[];
|
|
228
229
|
}
|
|
229
|
-
export interface
|
|
230
|
+
export interface IRevisionMetaDTO {
|
|
230
231
|
revisionDate: string;
|
|
231
232
|
note: string;
|
|
232
233
|
status: string;
|
|
233
234
|
}
|
|
234
|
-
export interface
|
|
235
|
-
type: string;
|
|
236
|
-
errorMsg: string;
|
|
237
|
-
}
|
|
238
|
-
export interface ISearchParams {
|
|
235
|
+
export interface ISearchParamsDTO {
|
|
239
236
|
page?: number;
|
|
240
237
|
pageSize?: number;
|
|
241
238
|
articleTypes?: string[];
|
|
@@ -251,23 +248,24 @@ export interface ISearchParams {
|
|
|
251
248
|
relevance?: string[];
|
|
252
249
|
languageFilter?: string[];
|
|
253
250
|
grepCodes?: string[];
|
|
251
|
+
traits?: SearchTrait[];
|
|
254
252
|
aggregatePaths?: string[];
|
|
255
253
|
embedResource?: string[];
|
|
256
254
|
embedId?: string;
|
|
257
255
|
filterInactive?: boolean;
|
|
258
256
|
sort?: string;
|
|
259
257
|
}
|
|
260
|
-
export interface
|
|
258
|
+
export interface ISearchSuggestionDTO {
|
|
261
259
|
text: string;
|
|
262
260
|
offset: number;
|
|
263
261
|
length: number;
|
|
264
|
-
options:
|
|
262
|
+
options: ISuggestOptionDTO[];
|
|
265
263
|
}
|
|
266
|
-
export interface
|
|
264
|
+
export interface IStatusDTO {
|
|
267
265
|
current: string;
|
|
268
266
|
other: string[];
|
|
269
267
|
}
|
|
270
|
-
export interface
|
|
268
|
+
export interface ISubjectAggregationDTO {
|
|
271
269
|
subjectId: string;
|
|
272
270
|
publishedArticleCount: number;
|
|
273
271
|
oldArticleCount: number;
|
|
@@ -275,35 +273,36 @@ export interface ISubjectAggregation {
|
|
|
275
273
|
flowCount: number;
|
|
276
274
|
favoritedCount: number;
|
|
277
275
|
}
|
|
278
|
-
export interface
|
|
279
|
-
subjects:
|
|
276
|
+
export interface ISubjectAggregationsDTO {
|
|
277
|
+
subjects: ISubjectAggregationDTO[];
|
|
280
278
|
}
|
|
281
|
-
export interface
|
|
279
|
+
export interface ISubjectAggsInputDTO {
|
|
282
280
|
subjects?: string[];
|
|
283
281
|
}
|
|
284
|
-
export interface
|
|
282
|
+
export interface ISuggestOptionDTO {
|
|
285
283
|
text: string;
|
|
286
284
|
score: number;
|
|
287
285
|
}
|
|
288
|
-
export interface
|
|
286
|
+
export interface ITaxonomyResourceTypeDTO {
|
|
289
287
|
id: string;
|
|
290
288
|
name: string;
|
|
291
289
|
language: string;
|
|
292
290
|
}
|
|
293
|
-
export interface
|
|
291
|
+
export interface ITermValueDTO {
|
|
294
292
|
value: string;
|
|
295
293
|
count: number;
|
|
296
294
|
}
|
|
297
|
-
export interface
|
|
295
|
+
export interface ITitleDTO {
|
|
298
296
|
title: string;
|
|
299
297
|
language: string;
|
|
300
298
|
}
|
|
301
|
-
export interface
|
|
299
|
+
export interface ITitleWithHtmlDTO {
|
|
302
300
|
title: string;
|
|
303
301
|
htmlTitle: string;
|
|
304
302
|
language: string;
|
|
305
303
|
}
|
|
306
304
|
export type LearningResourceType = ("standard" | "topic-article" | "frontpage-article" | "learningpath" | "concept" | "gloss");
|
|
305
|
+
export type SearchTrait = ("VIDEO" | "H5P" | "AUDIO" | "PODCAST");
|
|
307
306
|
export type SearchType = ("article" | "draft" | "learningpath" | "concept" | "grep");
|
|
308
307
|
export type Sort = SortEnum;
|
|
309
308
|
export declare enum SortEnum {
|
package/build/search-api.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"search-api.js","sourceRoot":"","sources":["../search-api.ts"],"names":[],"mappings":";AAAA,2CAA2C;;;
|
|
1
|
+
{"version":3,"file":"search-api.js","sourceRoot":"","sources":["../search-api.ts"],"names":[],"mappings":";AAAA,2CAA2C;;;AAgW3C,IAAY,QA6BX;AA7BD,WAAY,QAAQ;IAClB,0CAA8B,CAAA;IAC9B,wCAA4B,CAAA;IAC5B,kCAAsB,CAAA;IACtB,gCAAoB,CAAA;IACpB,8CAAkC,CAAA;IAClC,4CAAgC,CAAA;IAChC,4BAAgB,CAAA;IAChB,0BAAc,CAAA;IACd,wCAA4B,CAAA;IAC5B,sCAA0B,CAAA;IAC1B,8CAAkC,CAAA;IAClC,gDAAoC,CAAA;IACpC,kEAAsD,CAAA;IACtD,oEAAwD,CAAA;IACxD,kCAAsB,CAAA;IACtB,oCAAwB,CAAA;IACxB,8CAAkC,CAAA;IAClC,4CAAgC,CAAA;IAChC,sDAA0C,CAAA;IAC1C,oDAAwC,CAAA;IACxC,8CAAkC,CAAA;IAClC,4CAAgC,CAAA;IAChC,gDAAoC,CAAA;IACpC,8CAAkC,CAAA;IAClC,0CAA8B,CAAA;IAC9B,wCAA4B,CAAA;IAC5B,0CAA8B,CAAA;IAC9B,wCAA4B,CAAA;AAC9B,CAAC,EA7BW,QAAQ,wBAAR,QAAQ,QA6BnB"}
|
package/package.json
CHANGED