@ndla/types-backend 0.2.100 → 1.0.1
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 +91 -70
- 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,4 +1,5 @@
|
|
|
1
|
-
export
|
|
1
|
+
export type GrepSort = ("-relevance" | "relevance" | "-title" | "title" | "-code" | "code");
|
|
2
|
+
export interface IApiTaxonomyContextDTO {
|
|
2
3
|
publicId: string;
|
|
3
4
|
root: string;
|
|
4
5
|
rootId: string;
|
|
@@ -8,47 +9,47 @@ export interface IApiTaxonomyContext {
|
|
|
8
9
|
breadcrumbs: string[];
|
|
9
10
|
contextId: string;
|
|
10
11
|
contextType: string;
|
|
11
|
-
resourceTypes:
|
|
12
|
+
resourceTypes: ITaxonomyResourceTypeDTO[];
|
|
12
13
|
language: string;
|
|
13
14
|
isPrimary: boolean;
|
|
14
15
|
isActive: boolean;
|
|
15
16
|
url: string;
|
|
16
17
|
}
|
|
17
|
-
export interface
|
|
18
|
+
export interface IArticleIntroductionDTO {
|
|
18
19
|
introduction: string;
|
|
19
20
|
htmlIntroduction: string;
|
|
20
21
|
language: string;
|
|
21
22
|
}
|
|
22
|
-
export interface
|
|
23
|
+
export interface IArticleResultDTO {
|
|
23
24
|
id: number;
|
|
24
|
-
title:
|
|
25
|
-
introduction?:
|
|
25
|
+
title: ITitleWithHtmlDTO;
|
|
26
|
+
introduction?: IArticleIntroductionDTO;
|
|
26
27
|
articleType: string;
|
|
27
28
|
supportedLanguages: string[];
|
|
28
29
|
}
|
|
29
|
-
export interface
|
|
30
|
+
export interface IArticleResultsDTO {
|
|
30
31
|
type: string;
|
|
31
32
|
language: string;
|
|
32
33
|
totalCount: number;
|
|
33
34
|
page: number;
|
|
34
35
|
pageSize: number;
|
|
35
|
-
results:
|
|
36
|
+
results: IArticleResultDTO[];
|
|
36
37
|
}
|
|
37
|
-
export interface
|
|
38
|
+
export interface IAudioResultDTO {
|
|
38
39
|
id: number;
|
|
39
|
-
title:
|
|
40
|
+
title: ITitleDTO;
|
|
40
41
|
url: string;
|
|
41
42
|
supportedLanguages: string[];
|
|
42
43
|
}
|
|
43
|
-
export interface
|
|
44
|
+
export interface IAudioResultsDTO {
|
|
44
45
|
type: string;
|
|
45
46
|
language: string;
|
|
46
47
|
totalCount: number;
|
|
47
48
|
page: number;
|
|
48
49
|
pageSize: number;
|
|
49
|
-
results:
|
|
50
|
+
results: IAudioResultDTO[];
|
|
50
51
|
}
|
|
51
|
-
export interface
|
|
52
|
+
export interface ICommentDTO {
|
|
52
53
|
id: string;
|
|
53
54
|
content: string;
|
|
54
55
|
created: string;
|
|
@@ -56,11 +57,11 @@ export interface IComment {
|
|
|
56
57
|
isOpen: boolean;
|
|
57
58
|
solved: boolean;
|
|
58
59
|
}
|
|
59
|
-
export interface
|
|
60
|
+
export interface IDraftResponsibleDTO {
|
|
60
61
|
responsibleId: string;
|
|
61
62
|
lastUpdated: string;
|
|
62
63
|
}
|
|
63
|
-
export interface
|
|
64
|
+
export interface IDraftSearchParamsDTO {
|
|
64
65
|
page?: number;
|
|
65
66
|
pageSize?: number;
|
|
66
67
|
articleTypes?: string[];
|
|
@@ -96,99 +97,119 @@ export interface IDraftSearchParams {
|
|
|
96
97
|
publishedDateTo?: string;
|
|
97
98
|
resultTypes?: SearchType[];
|
|
98
99
|
}
|
|
99
|
-
export interface
|
|
100
|
+
export interface IGrepResultDTO {
|
|
101
|
+
code: string;
|
|
102
|
+
title: ITitleDTO;
|
|
103
|
+
}
|
|
104
|
+
export interface IGrepSearchInputDTO {
|
|
105
|
+
prefixFilter?: string[];
|
|
106
|
+
codes?: string[];
|
|
107
|
+
query?: string;
|
|
108
|
+
page?: number;
|
|
109
|
+
pageSize?: number;
|
|
110
|
+
sort?: GrepSort;
|
|
111
|
+
language?: string;
|
|
112
|
+
}
|
|
113
|
+
export interface IGrepSearchResultsDTO {
|
|
114
|
+
totalCount: number;
|
|
115
|
+
page: number;
|
|
116
|
+
pageSize: number;
|
|
117
|
+
language: string;
|
|
118
|
+
results: IGrepResultDTO[];
|
|
119
|
+
}
|
|
120
|
+
export interface IGroupSearchResultDTO {
|
|
100
121
|
totalCount: number;
|
|
101
122
|
page?: number;
|
|
102
123
|
pageSize: number;
|
|
103
124
|
language: string;
|
|
104
|
-
results:
|
|
105
|
-
suggestions:
|
|
106
|
-
aggregations:
|
|
125
|
+
results: IMultiSearchSummaryDTO[];
|
|
126
|
+
suggestions: IMultiSearchSuggestionDTO[];
|
|
127
|
+
aggregations: IMultiSearchTermsAggregationDTO[];
|
|
107
128
|
resourceType: string;
|
|
108
129
|
}
|
|
109
|
-
export interface
|
|
130
|
+
export interface IHighlightedFieldDTO {
|
|
110
131
|
field: string;
|
|
111
132
|
matches: string[];
|
|
112
133
|
}
|
|
113
|
-
export interface
|
|
134
|
+
export interface IImageAltTextDTO {
|
|
114
135
|
altText: string;
|
|
115
136
|
language: string;
|
|
116
137
|
}
|
|
117
|
-
export interface
|
|
138
|
+
export interface IImageResultDTO {
|
|
118
139
|
id: number;
|
|
119
|
-
title:
|
|
120
|
-
altText:
|
|
140
|
+
title: ITitleDTO;
|
|
141
|
+
altText: IImageAltTextDTO;
|
|
121
142
|
previewUrl: string;
|
|
122
143
|
metaUrl: string;
|
|
123
144
|
supportedLanguages: string[];
|
|
124
145
|
}
|
|
125
|
-
export interface
|
|
146
|
+
export interface IImageResultsDTO {
|
|
126
147
|
type: string;
|
|
127
148
|
language: string;
|
|
128
149
|
totalCount: number;
|
|
129
150
|
page: number;
|
|
130
151
|
pageSize: number;
|
|
131
|
-
results:
|
|
152
|
+
results: IImageResultDTO[];
|
|
132
153
|
}
|
|
133
|
-
export interface
|
|
154
|
+
export interface ILearningPathIntroductionDTO {
|
|
134
155
|
introduction: string;
|
|
135
156
|
language: string;
|
|
136
157
|
}
|
|
137
|
-
export interface
|
|
158
|
+
export interface ILearningpathResultDTO {
|
|
138
159
|
id: number;
|
|
139
|
-
title:
|
|
140
|
-
introduction:
|
|
160
|
+
title: ITitleDTO;
|
|
161
|
+
introduction: ILearningPathIntroductionDTO;
|
|
141
162
|
supportedLanguages: string[];
|
|
142
163
|
}
|
|
143
|
-
export interface
|
|
164
|
+
export interface ILearningpathResultsDTO {
|
|
144
165
|
type: string;
|
|
145
166
|
language: string;
|
|
146
167
|
totalCount: number;
|
|
147
168
|
page: number;
|
|
148
169
|
pageSize: number;
|
|
149
|
-
results:
|
|
170
|
+
results: ILearningpathResultDTO[];
|
|
150
171
|
}
|
|
151
|
-
export interface
|
|
172
|
+
export interface IMetaDescriptionDTO {
|
|
152
173
|
metaDescription: string;
|
|
153
174
|
language: string;
|
|
154
175
|
}
|
|
155
|
-
export interface
|
|
176
|
+
export interface IMetaImageDTO {
|
|
156
177
|
url: string;
|
|
157
178
|
alt: string;
|
|
158
179
|
language: string;
|
|
159
180
|
}
|
|
160
|
-
export interface
|
|
181
|
+
export interface IMultiSearchResultDTO {
|
|
161
182
|
totalCount: number;
|
|
162
183
|
page?: number;
|
|
163
184
|
pageSize: number;
|
|
164
185
|
language: string;
|
|
165
|
-
results:
|
|
166
|
-
suggestions:
|
|
167
|
-
aggregations:
|
|
186
|
+
results: IMultiSearchSummaryDTO[];
|
|
187
|
+
suggestions: IMultiSearchSuggestionDTO[];
|
|
188
|
+
aggregations: IMultiSearchTermsAggregationDTO[];
|
|
168
189
|
}
|
|
169
|
-
export interface
|
|
190
|
+
export interface IMultiSearchSuggestionDTO {
|
|
170
191
|
name: string;
|
|
171
|
-
suggestions:
|
|
192
|
+
suggestions: ISearchSuggestionDTO[];
|
|
172
193
|
}
|
|
173
|
-
export interface
|
|
194
|
+
export interface IMultiSearchSummaryDTO {
|
|
174
195
|
id: number;
|
|
175
|
-
title:
|
|
176
|
-
metaDescription:
|
|
177
|
-
metaImage?:
|
|
196
|
+
title: ITitleWithHtmlDTO;
|
|
197
|
+
metaDescription: IMetaDescriptionDTO;
|
|
198
|
+
metaImage?: IMetaImageDTO;
|
|
178
199
|
url: string;
|
|
179
|
-
contexts:
|
|
200
|
+
contexts: IApiTaxonomyContextDTO[];
|
|
180
201
|
supportedLanguages: string[];
|
|
181
202
|
learningResourceType: LearningResourceType;
|
|
182
|
-
status?:
|
|
203
|
+
status?: IStatusDTO;
|
|
183
204
|
traits: string[];
|
|
184
205
|
score: number;
|
|
185
|
-
highlights:
|
|
206
|
+
highlights: IHighlightedFieldDTO[];
|
|
186
207
|
paths: string[];
|
|
187
208
|
lastUpdated: string;
|
|
188
209
|
license?: string;
|
|
189
|
-
revisions:
|
|
190
|
-
responsible?:
|
|
191
|
-
comments?:
|
|
210
|
+
revisions: IRevisionMetaDTO[];
|
|
211
|
+
responsible?: IDraftResponsibleDTO;
|
|
212
|
+
comments?: ICommentDTO[];
|
|
192
213
|
prioritized?: boolean;
|
|
193
214
|
priority?: string;
|
|
194
215
|
resourceTypeName?: string;
|
|
@@ -199,22 +220,18 @@ export interface IMultiSearchSummary {
|
|
|
199
220
|
resultType: SearchType;
|
|
200
221
|
conceptSubjectIds?: string[];
|
|
201
222
|
}
|
|
202
|
-
export interface
|
|
223
|
+
export interface IMultiSearchTermsAggregationDTO {
|
|
203
224
|
field: string;
|
|
204
225
|
sumOtherDocCount: number;
|
|
205
226
|
docCountErrorUpperBound: number;
|
|
206
|
-
values:
|
|
227
|
+
values: ITermValueDTO[];
|
|
207
228
|
}
|
|
208
|
-
export interface
|
|
229
|
+
export interface IRevisionMetaDTO {
|
|
209
230
|
revisionDate: string;
|
|
210
231
|
note: string;
|
|
211
232
|
status: string;
|
|
212
233
|
}
|
|
213
|
-
export interface
|
|
214
|
-
type: string;
|
|
215
|
-
errorMsg: string;
|
|
216
|
-
}
|
|
217
|
-
export interface ISearchParams {
|
|
234
|
+
export interface ISearchParamsDTO {
|
|
218
235
|
page?: number;
|
|
219
236
|
pageSize?: number;
|
|
220
237
|
articleTypes?: string[];
|
|
@@ -236,17 +253,17 @@ export interface ISearchParams {
|
|
|
236
253
|
filterInactive?: boolean;
|
|
237
254
|
sort?: string;
|
|
238
255
|
}
|
|
239
|
-
export interface
|
|
256
|
+
export interface ISearchSuggestionDTO {
|
|
240
257
|
text: string;
|
|
241
258
|
offset: number;
|
|
242
259
|
length: number;
|
|
243
|
-
options:
|
|
260
|
+
options: ISuggestOptionDTO[];
|
|
244
261
|
}
|
|
245
|
-
export interface
|
|
262
|
+
export interface IStatusDTO {
|
|
246
263
|
current: string;
|
|
247
264
|
other: string[];
|
|
248
265
|
}
|
|
249
|
-
export interface
|
|
266
|
+
export interface ISubjectAggregationDTO {
|
|
250
267
|
subjectId: string;
|
|
251
268
|
publishedArticleCount: number;
|
|
252
269
|
oldArticleCount: number;
|
|
@@ -254,32 +271,36 @@ export interface ISubjectAggregation {
|
|
|
254
271
|
flowCount: number;
|
|
255
272
|
favoritedCount: number;
|
|
256
273
|
}
|
|
257
|
-
export interface
|
|
258
|
-
subjects:
|
|
274
|
+
export interface ISubjectAggregationsDTO {
|
|
275
|
+
subjects: ISubjectAggregationDTO[];
|
|
259
276
|
}
|
|
260
|
-
export interface
|
|
277
|
+
export interface ISubjectAggsInputDTO {
|
|
261
278
|
subjects?: string[];
|
|
262
279
|
}
|
|
263
|
-
export interface
|
|
280
|
+
export interface ISuggestOptionDTO {
|
|
264
281
|
text: string;
|
|
265
282
|
score: number;
|
|
266
283
|
}
|
|
267
|
-
export interface
|
|
284
|
+
export interface ITaxonomyResourceTypeDTO {
|
|
268
285
|
id: string;
|
|
269
286
|
name: string;
|
|
270
287
|
language: string;
|
|
271
288
|
}
|
|
272
|
-
export interface
|
|
289
|
+
export interface ITermValueDTO {
|
|
273
290
|
value: string;
|
|
274
291
|
count: number;
|
|
275
292
|
}
|
|
276
|
-
export interface
|
|
293
|
+
export interface ITitleDTO {
|
|
294
|
+
title: string;
|
|
295
|
+
language: string;
|
|
296
|
+
}
|
|
297
|
+
export interface ITitleWithHtmlDTO {
|
|
277
298
|
title: string;
|
|
278
299
|
htmlTitle: string;
|
|
279
300
|
language: string;
|
|
280
301
|
}
|
|
281
302
|
export type LearningResourceType = ("standard" | "topic-article" | "frontpage-article" | "learningpath" | "concept" | "gloss");
|
|
282
|
-
export type SearchType = ("article" | "draft" | "learningpath" | "concept");
|
|
303
|
+
export type SearchType = ("article" | "draft" | "learningpath" | "concept" | "grep");
|
|
283
304
|
export type Sort = SortEnum;
|
|
284
305
|
export declare enum SortEnum {
|
|
285
306
|
ByRelevanceDesc = "-relevance",
|
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;;;AA4V3C,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