@ndla/types-backend 0.2.78 → 0.2.80

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.
@@ -1,3 +1,13 @@
1
+ export declare enum ArticleSortEnum {
2
+ ByRelevanceDesc = "-relevance",
3
+ ByRelevanceAsc = "relevance",
4
+ ByTitleDesc = "-title",
5
+ ByTitleAsc = "title",
6
+ ByLastUpdatedDesc = "-lastUpdated",
7
+ ByLastUpdatedAsc = "lastUpdated",
8
+ ByIdDesc = "-id",
9
+ ByIdAsc = "id"
10
+ }
1
11
  export type Availability = ("everyone" | "teacher");
2
12
  export interface IArticleContentV2 {
3
13
  content: string;
@@ -36,7 +46,7 @@ export interface IArticleSearchParams {
36
46
  pageSize?: number;
37
47
  ids?: number[];
38
48
  articleTypes?: string[];
39
- sort?: string;
49
+ sort?: Sort;
40
50
  fallback?: boolean;
41
51
  scrollId?: string;
42
52
  grepCodes?: string[];
@@ -147,3 +157,4 @@ export interface IVisualElement {
147
157
  visualElement: string;
148
158
  language: string;
149
159
  }
160
+ export type Sort = ArticleSortEnum;
@@ -1,4 +1,16 @@
1
1
  "use strict";
2
2
  // DO NOT EDIT: generated file by scala-tsi
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.ArticleSortEnum = void 0;
5
+ var ArticleSortEnum;
6
+ (function (ArticleSortEnum) {
7
+ ArticleSortEnum["ByRelevanceDesc"] = "-relevance";
8
+ ArticleSortEnum["ByRelevanceAsc"] = "relevance";
9
+ ArticleSortEnum["ByTitleDesc"] = "-title";
10
+ ArticleSortEnum["ByTitleAsc"] = "title";
11
+ ArticleSortEnum["ByLastUpdatedDesc"] = "-lastUpdated";
12
+ ArticleSortEnum["ByLastUpdatedAsc"] = "lastUpdated";
13
+ ArticleSortEnum["ByIdDesc"] = "-id";
14
+ ArticleSortEnum["ByIdAsc"] = "id";
15
+ })(ArticleSortEnum || (exports.ArticleSortEnum = ArticleSortEnum = {}));
4
16
  //# sourceMappingURL=article-api.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"article-api.js","sourceRoot":"","sources":["../article-api.ts"],"names":[],"mappings":";AAAA,2CAA2C"}
1
+ {"version":3,"file":"article-api.js","sourceRoot":"","sources":["../article-api.ts"],"names":[],"mappings":";AAAA,2CAA2C;;;AAE3C,IAAY,eASX;AATD,WAAY,eAAe;IACzB,iDAA8B,CAAA;IAC9B,+CAA4B,CAAA;IAC5B,yCAAsB,CAAA;IACtB,uCAAoB,CAAA;IACpB,qDAAkC,CAAA;IAClC,mDAAgC,CAAA;IAChC,mCAAgB,CAAA;IAChB,iCAAc,CAAA;AAChB,CAAC,EATW,eAAe,+BAAf,eAAe,QAS1B"}
@@ -1,3 +1,13 @@
1
+ export declare enum AudioSortEnum {
2
+ ByRelevanceDesc = "-relevance",
3
+ ByRelevanceAsc = "relevance",
4
+ ByTitleDesc = "-title",
5
+ ByTitleAsc = "title",
6
+ ByLastUpdatedDesc = "-lastUpdated",
7
+ ByLastUpdatedAsc = "lastUpdated",
8
+ ByIdDesc = "-id",
9
+ ByIdAsc = "id"
10
+ }
1
11
  export interface IAudio {
2
12
  url: string;
3
13
  mimeType: string;
@@ -106,7 +116,7 @@ export interface ISearchParams {
106
116
  language?: string;
107
117
  page?: number;
108
118
  pageSize?: number;
109
- sort?: string;
119
+ sort?: Sort;
110
120
  scrollId?: string;
111
121
  audioType?: string;
112
122
  filterBySeries?: boolean;
@@ -127,7 +137,7 @@ export interface ISeriesSearchParams {
127
137
  language?: string;
128
138
  page?: number;
129
139
  pageSize?: number;
130
- sort?: string;
140
+ sort?: Sort;
131
141
  scrollId?: string;
132
142
  fallback?: boolean;
133
143
  }
@@ -172,3 +182,4 @@ export interface IUpdatedAudioMetaInformation {
172
182
  seriesId?: number;
173
183
  manuscript?: string;
174
184
  }
185
+ export type Sort = AudioSortEnum;
@@ -1,4 +1,16 @@
1
1
  "use strict";
2
2
  // DO NOT EDIT: generated file by scala-tsi
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.AudioSortEnum = void 0;
5
+ var AudioSortEnum;
6
+ (function (AudioSortEnum) {
7
+ AudioSortEnum["ByRelevanceDesc"] = "-relevance";
8
+ AudioSortEnum["ByRelevanceAsc"] = "relevance";
9
+ AudioSortEnum["ByTitleDesc"] = "-title";
10
+ AudioSortEnum["ByTitleAsc"] = "title";
11
+ AudioSortEnum["ByLastUpdatedDesc"] = "-lastUpdated";
12
+ AudioSortEnum["ByLastUpdatedAsc"] = "lastUpdated";
13
+ AudioSortEnum["ByIdDesc"] = "-id";
14
+ AudioSortEnum["ByIdAsc"] = "id";
15
+ })(AudioSortEnum || (exports.AudioSortEnum = AudioSortEnum = {}));
4
16
  //# sourceMappingURL=audio-api.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"audio-api.js","sourceRoot":"","sources":["../audio-api.ts"],"names":[],"mappings":";AAAA,2CAA2C"}
1
+ {"version":3,"file":"audio-api.js","sourceRoot":"","sources":["../audio-api.ts"],"names":[],"mappings":";AAAA,2CAA2C;;;AAE3C,IAAY,aASX;AATD,WAAY,aAAa;IACvB,+CAA8B,CAAA;IAC9B,6CAA4B,CAAA;IAC5B,uCAAsB,CAAA;IACtB,qCAAoB,CAAA;IACpB,mDAAkC,CAAA;IAClC,iDAAgC,CAAA;IAChC,iCAAgB,CAAA;IAChB,+BAAc,CAAA;AAChB,CAAC,EATW,aAAa,6BAAb,aAAa,QASxB"}
@@ -1,3 +1,21 @@
1
+ export declare enum ConceptSortEnum {
2
+ ByRelevanceDesc = "-relevance",
3
+ ByRelevanceAsc = "relevance",
4
+ ByTitleDesc = "-title",
5
+ ByTitleAsc = "title",
6
+ ByLastUpdatedDesc = "-lastUpdated",
7
+ ByLastUpdatedAsc = "lastUpdated",
8
+ ByIdDesc = "-id",
9
+ ByIdAsc = "id",
10
+ ByResponsibleLastUpdatedDesc = "-responsibleLastUpdated",
11
+ ByResponsibleLastUpdatedAsc = "responsibleLastUpdated",
12
+ ByStatusAsc = "status",
13
+ ByStatusDesc = "-status",
14
+ BySubjectAsc = "subject",
15
+ BySubjectDesc = "-subject",
16
+ ByConceptTypeAsc = "conceptType",
17
+ ByConceptTypeDesc = "-conceptType"
18
+ }
1
19
  export interface IAuthor {
2
20
  type: string;
3
21
  name: string;
@@ -44,7 +62,7 @@ export interface IConceptSearchParams {
44
62
  page?: number;
45
63
  pageSize?: number;
46
64
  ids?: number[];
47
- sort?: string;
65
+ sort?: Sort;
48
66
  fallback?: boolean;
49
67
  scrollId?: string;
50
68
  subjects?: string[];
@@ -100,7 +118,7 @@ export interface IDraftConceptSearchParams {
100
118
  page?: number;
101
119
  pageSize?: number;
102
120
  ids?: number[];
103
- sort?: string;
121
+ sort?: Sort;
104
122
  fallback?: boolean;
105
123
  scrollId?: string;
106
124
  subjects?: string[];
@@ -223,5 +241,6 @@ export interface IVisualElement {
223
241
  visualElement: string;
224
242
  language: string;
225
243
  }
244
+ export type Sort = ConceptSortEnum;
226
245
  export type UpdateOrDeleteNewConceptMetaImage = (null | undefined | INewConceptMetaImage);
227
246
  export type UpdateOrDeleteString = (null | undefined | string);
@@ -1,4 +1,24 @@
1
1
  "use strict";
2
2
  // DO NOT EDIT: generated file by scala-tsi
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.ConceptSortEnum = void 0;
5
+ var ConceptSortEnum;
6
+ (function (ConceptSortEnum) {
7
+ ConceptSortEnum["ByRelevanceDesc"] = "-relevance";
8
+ ConceptSortEnum["ByRelevanceAsc"] = "relevance";
9
+ ConceptSortEnum["ByTitleDesc"] = "-title";
10
+ ConceptSortEnum["ByTitleAsc"] = "title";
11
+ ConceptSortEnum["ByLastUpdatedDesc"] = "-lastUpdated";
12
+ ConceptSortEnum["ByLastUpdatedAsc"] = "lastUpdated";
13
+ ConceptSortEnum["ByIdDesc"] = "-id";
14
+ ConceptSortEnum["ByIdAsc"] = "id";
15
+ ConceptSortEnum["ByResponsibleLastUpdatedDesc"] = "-responsibleLastUpdated";
16
+ ConceptSortEnum["ByResponsibleLastUpdatedAsc"] = "responsibleLastUpdated";
17
+ ConceptSortEnum["ByStatusAsc"] = "status";
18
+ ConceptSortEnum["ByStatusDesc"] = "-status";
19
+ ConceptSortEnum["BySubjectAsc"] = "subject";
20
+ ConceptSortEnum["BySubjectDesc"] = "-subject";
21
+ ConceptSortEnum["ByConceptTypeAsc"] = "conceptType";
22
+ ConceptSortEnum["ByConceptTypeDesc"] = "-conceptType";
23
+ })(ConceptSortEnum || (exports.ConceptSortEnum = ConceptSortEnum = {}));
4
24
  //# sourceMappingURL=concept-api.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"concept-api.js","sourceRoot":"","sources":["../concept-api.ts"],"names":[],"mappings":";AAAA,2CAA2C"}
1
+ {"version":3,"file":"concept-api.js","sourceRoot":"","sources":["../concept-api.ts"],"names":[],"mappings":";AAAA,2CAA2C;;;AAE3C,IAAY,eAiBX;AAjBD,WAAY,eAAe;IACzB,iDAA8B,CAAA;IAC9B,+CAA4B,CAAA;IAC5B,yCAAsB,CAAA;IACtB,uCAAoB,CAAA;IACpB,qDAAkC,CAAA;IAClC,mDAAgC,CAAA;IAChC,mCAAgB,CAAA;IAChB,iCAAc,CAAA;IACd,2EAAwD,CAAA;IACxD,yEAAsD,CAAA;IACtD,yCAAsB,CAAA;IACtB,2CAAwB,CAAA;IACxB,2CAAwB,CAAA;IACxB,6CAA0B,CAAA;IAC1B,mDAAgC,CAAA;IAChC,qDAAkC,CAAA;AACpC,CAAC,EAjBW,eAAe,+BAAf,eAAe,QAiB1B"}
@@ -121,7 +121,7 @@ export interface ISearchParams {
121
121
  fallback?: boolean;
122
122
  minimumSize?: number;
123
123
  includeCopyrighted?: boolean;
124
- sort?: string;
124
+ sort?: Sort;
125
125
  page?: number;
126
126
  pageSize?: number;
127
127
  podcastFriendly?: boolean;
@@ -168,4 +168,15 @@ export interface IValidationMessage {
168
168
  field: string;
169
169
  message: string;
170
170
  }
171
+ export declare enum ImageSortEnum {
172
+ ByRelevanceDesc = "-relevance",
173
+ ByRelevanceAsc = "relevance",
174
+ ByTitleDesc = "-title",
175
+ ByTitleAsc = "title",
176
+ ByLastUpdatedDesc = "-lastUpdated",
177
+ ByLastUpdatedAsc = "lastUpdated",
178
+ ByIdDesc = "-id",
179
+ ByIdAsc = "id"
180
+ }
181
+ export type Sort = ImageSortEnum;
171
182
  export type UpdateOrDeleteString = (null | undefined | string);
@@ -1,4 +1,16 @@
1
1
  "use strict";
2
2
  // DO NOT EDIT: generated file by scala-tsi
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.ImageSortEnum = void 0;
5
+ var ImageSortEnum;
6
+ (function (ImageSortEnum) {
7
+ ImageSortEnum["ByRelevanceDesc"] = "-relevance";
8
+ ImageSortEnum["ByRelevanceAsc"] = "relevance";
9
+ ImageSortEnum["ByTitleDesc"] = "-title";
10
+ ImageSortEnum["ByTitleAsc"] = "title";
11
+ ImageSortEnum["ByLastUpdatedDesc"] = "-lastUpdated";
12
+ ImageSortEnum["ByLastUpdatedAsc"] = "lastUpdated";
13
+ ImageSortEnum["ByIdDesc"] = "-id";
14
+ ImageSortEnum["ByIdAsc"] = "id";
15
+ })(ImageSortEnum || (exports.ImageSortEnum = ImageSortEnum = {}));
4
16
  //# sourceMappingURL=image-api.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"image-api.js","sourceRoot":"","sources":["../image-api.ts"],"names":[],"mappings":";AAAA,2CAA2C"}
1
+ {"version":3,"file":"image-api.js","sourceRoot":"","sources":["../image-api.ts"],"names":[],"mappings":";AAAA,2CAA2C;;;AAkM3C,IAAY,aASX;AATD,WAAY,aAAa;IACvB,+CAA8B,CAAA;IAC9B,6CAA4B,CAAA;IAC5B,uCAAsB,CAAA;IACtB,qCAAoB,CAAA;IACpB,mDAAkC,CAAA;IAClC,iDAAgC,CAAA;IAChC,iCAAgB,CAAA;IAChB,+BAAc,CAAA;AAChB,CAAC,EATW,aAAa,6BAAb,aAAa,QASxB"}
@@ -237,4 +237,8 @@ export interface IUpdatedResource {
237
237
  tags?: string[];
238
238
  resourceId?: string;
239
239
  }
240
+ export interface IUserFolder {
241
+ folders: IFolder[];
242
+ sharedFolders: IFolder[];
243
+ }
240
244
  export type ResourceType = ("concept" | "image" | "audio" | "multidisciplinary" | "article" | "learningpath" | "video" | "folder");
@@ -68,7 +68,7 @@ export interface IDraftSearchParams {
68
68
  license?: string;
69
69
  query?: string;
70
70
  noteQuery?: string;
71
- sort?: string;
71
+ sort?: Sort;
72
72
  fallback?: boolean;
73
73
  subjects?: string[];
74
74
  languageFilter?: string[];
@@ -254,3 +254,34 @@ export interface ITitle {
254
254
  }
255
255
  export type LearningResourceType = ("standard" | "topic-article" | "frontpage-article" | "learningpath" | "concept" | "gloss");
256
256
  export type SearchType = ("article" | "draft" | "learningpath" | "concept");
257
+ export type Sort = SortEnum;
258
+ export declare enum SortEnum {
259
+ ByRelevanceDesc = "-relevance",
260
+ ByRelevanceAsc = "relevance",
261
+ ByTitleDesc = "-title",
262
+ ByTitleAsc = "title",
263
+ ByLastUpdatedDesc = "-lastUpdated",
264
+ ByLastUpdatedAsc = "lastUpdated",
265
+ ByIdDesc = "-id",
266
+ ByIdAsc = "id",
267
+ ByDurationDesc = "-duration",
268
+ ByDurationAsc = "duration",
269
+ ByRevisionDateAsc = "revisionDate",
270
+ ByRevisionDateDesc = "-revisionDate",
271
+ ByResponsibleLastUpdatedAsc = "responsibleLastUpdated",
272
+ ByResponsibleLastUpdatedDesc = "-responsibleLastUpdated",
273
+ ByStatusAsc = "status",
274
+ ByStatusDesc = "-status",
275
+ ByPrioritizedDesc = "-prioritized",
276
+ ByPrioritizedAsc = "prioritized",
277
+ ByParentTopicNameDesc = "-parentTopicName",
278
+ ByParentTopicNameAsc = "parentTopicName",
279
+ ByPrimaryRootDesc = "-primaryRoot",
280
+ ByPrimaryRootAsc = "primaryRoot",
281
+ ByResourceTypeDesc = "-resourceType",
282
+ ByResourceTypeAsc = "resourceType",
283
+ ByPublishedDesc = "-published",
284
+ ByPublishedAsc = "published",
285
+ ByFavoritedDesc = "-favorited",
286
+ ByFavoritedAsc = "favorited"
287
+ }
@@ -1,4 +1,36 @@
1
1
  "use strict";
2
2
  // DO NOT EDIT: generated file by scala-tsi
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.SortEnum = void 0;
5
+ var SortEnum;
6
+ (function (SortEnum) {
7
+ SortEnum["ByRelevanceDesc"] = "-relevance";
8
+ SortEnum["ByRelevanceAsc"] = "relevance";
9
+ SortEnum["ByTitleDesc"] = "-title";
10
+ SortEnum["ByTitleAsc"] = "title";
11
+ SortEnum["ByLastUpdatedDesc"] = "-lastUpdated";
12
+ SortEnum["ByLastUpdatedAsc"] = "lastUpdated";
13
+ SortEnum["ByIdDesc"] = "-id";
14
+ SortEnum["ByIdAsc"] = "id";
15
+ SortEnum["ByDurationDesc"] = "-duration";
16
+ SortEnum["ByDurationAsc"] = "duration";
17
+ SortEnum["ByRevisionDateAsc"] = "revisionDate";
18
+ SortEnum["ByRevisionDateDesc"] = "-revisionDate";
19
+ SortEnum["ByResponsibleLastUpdatedAsc"] = "responsibleLastUpdated";
20
+ SortEnum["ByResponsibleLastUpdatedDesc"] = "-responsibleLastUpdated";
21
+ SortEnum["ByStatusAsc"] = "status";
22
+ SortEnum["ByStatusDesc"] = "-status";
23
+ SortEnum["ByPrioritizedDesc"] = "-prioritized";
24
+ SortEnum["ByPrioritizedAsc"] = "prioritized";
25
+ SortEnum["ByParentTopicNameDesc"] = "-parentTopicName";
26
+ SortEnum["ByParentTopicNameAsc"] = "parentTopicName";
27
+ SortEnum["ByPrimaryRootDesc"] = "-primaryRoot";
28
+ SortEnum["ByPrimaryRootAsc"] = "primaryRoot";
29
+ SortEnum["ByResourceTypeDesc"] = "-resourceType";
30
+ SortEnum["ByResourceTypeAsc"] = "resourceType";
31
+ SortEnum["ByPublishedDesc"] = "-published";
32
+ SortEnum["ByPublishedAsc"] = "published";
33
+ SortEnum["ByFavoritedDesc"] = "-favorited";
34
+ SortEnum["ByFavoritedAsc"] = "favorited";
35
+ })(SortEnum || (exports.SortEnum = SortEnum = {}));
4
36
  //# sourceMappingURL=search-api.js.map
@@ -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;;;AAwS3C,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
@@ -27,5 +27,5 @@
27
27
  "devDependencies": {
28
28
  "typescript": "^5.3.3"
29
29
  },
30
- "version": "0.2.78"
30
+ "version": "0.2.80"
31
31
  }