@ndla/types-backend 0.2.18 → 0.2.20

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 (9) hide show
  1. package/build/article-api.d.ts +7 -11
  2. package/build/audio-api.d.ts +5 -9
  3. package/build/concept-api.d.ts +7 -11
  4. package/build/draft-api.d.ts +13 -58
  5. package/build/frontpage-api.d.ts +1 -4
  6. package/build/image-api.d.ts +6 -9
  7. package/build/learningpath-api.d.ts +8 -11
  8. package/build/search-api.d.ts +5 -8
  9. package/package.json +1 -1
package/build/article-api.d.ts CHANGED
@@ -50,7 +50,7 @@ export interface IArticleSummaryV2 {
50
50
  url: string;
51
51
  license: string;
52
52
  articleType: string;
53
- lastUpdated: INDLADate;
53
+ lastUpdated: string;
54
54
  supportedLanguages: string[];
55
55
  grepCodes: string[];
56
56
  availability: string;
@@ -76,17 +76,17 @@ export interface IArticleV2 {
76
76
  metaImage?: IArticleMetaImage;
77
77
  introduction?: IArticleIntroduction;
78
78
  metaDescription: IArticleMetaDescription;
79
- created: INDLADate;
80
- updated: INDLADate;
79
+ created: string;
80
+ updated: string;
81
81
  updatedBy: string;
82
- published: INDLADate;
82
+ published: string;
83
83
  articleType: string;
84
84
  supportedLanguages: string[];
85
85
  grepCodes: string[];
86
86
  conceptIds: number[];
87
87
  availability: string;
88
88
  relatedContent: (IRelatedContentLink | number)[];
89
- revisionDate?: INDLADate;
89
+ revisionDate?: string;
90
90
  slug?: string;
91
91
  }
92
92
  export interface IAuthor {
@@ -99,18 +99,14 @@ export interface ICopyright {
99
99
  creators: IAuthor[];
100
100
  processors: IAuthor[];
101
101
  rightsholders: IAuthor[];
102
- agreementId?: number;
103
- validFrom?: INDLADate;
104
- validTo?: INDLADate;
102
+ validFrom?: string;
103
+ validTo?: string;
105
104
  }
106
105
  export interface ILicense {
107
106
  license: string;
108
107
  description?: string;
109
108
  url?: string;
110
109
  }
111
- export interface INDLADate {
112
- underlying: string;
113
- }
114
110
  export interface IRelatedContentLink {
115
111
  title: string;
116
112
  url: string;
package/build/audio-api.d.ts CHANGED
@@ -16,8 +16,8 @@ export interface IAudioMetaInformation {
16
16
  podcastMeta?: IPodcastMeta;
17
17
  series?: ISeries;
18
18
  manuscript?: IManuscript;
19
- created: INDLADate;
20
- updated: INDLADate;
19
+ created: string;
20
+ updated: string;
21
21
  }
22
22
  export interface IAudioSummary {
23
23
  id: number;
@@ -29,7 +29,7 @@ export interface IAudioSummary {
29
29
  manuscript?: IManuscript;
30
30
  podcastMeta?: IPodcastMeta;
31
31
  series?: ISeriesSummary;
32
- lastUpdated: INDLADate;
32
+ lastUpdated: string;
33
33
  }
34
34
  export interface IAudioSummarySearchResult {
35
35
  totalCount: number;
@@ -48,9 +48,8 @@ export interface ICopyright {
48
48
  creators: IAuthor[];
49
49
  processors: IAuthor[];
50
50
  rightsholders: IAuthor[];
51
- agreementId?: number;
52
- validFrom?: INDLADate;
53
- validTo?: INDLADate;
51
+ validFrom?: string;
52
+ validTo?: string;
54
53
  }
55
54
  export interface ICoverPhoto {
56
55
  id: string;
@@ -70,9 +69,6 @@ export interface IManuscript {
70
69
  manuscript: string;
71
70
  language: string;
72
71
  }
73
- export interface INDLADate {
74
- underlying: string;
75
- }
76
72
  export interface INewAudioMetaInformation {
77
73
  title: string;
78
74
  language: string;
package/build/concept-api.d.ts CHANGED
@@ -12,8 +12,8 @@ export interface IConcept {
12
12
  metaImage?: IConceptMetaImage;
13
13
  tags?: IConceptTags;
14
14
  subjectIds?: string[];
15
- created: INDLADate;
16
- updated: INDLADate;
15
+ created: string;
16
+ updated: string;
17
17
  updatedBy?: string[];
18
18
  supportedLanguages: string[];
19
19
  articleIds: number[];
@@ -34,7 +34,7 @@ export interface IConceptMetaImage {
34
34
  }
35
35
  export interface IConceptResponsible {
36
36
  responsibleId: string;
37
- lastUpdated: INDLADate;
37
+ lastUpdated: string;
38
38
  }
39
39
  export interface IConceptSearchParams {
40
40
  query?: string;
@@ -67,8 +67,8 @@ export interface IConceptSummary {
67
67
  tags?: IConceptTags;
68
68
  subjectIds?: string[];
69
69
  supportedLanguages: string[];
70
- lastUpdated: INDLADate;
71
- created: INDLADate;
70
+ lastUpdated: string;
71
+ created: string;
72
72
  status: IStatus;
73
73
  updatedBy: string[];
74
74
  license?: string;
@@ -93,9 +93,8 @@ export interface ICopyright {
93
93
  creators: IAuthor[];
94
94
  processors: IAuthor[];
95
95
  rightsholders: IAuthor[];
96
- agreementId?: number;
97
- validFrom?: INDLADate;
98
- validTo?: INDLADate;
96
+ validFrom?: string;
97
+ validTo?: string;
99
98
  }
100
99
  export interface IDraftConceptSearchParams {
101
100
  query?: string;
@@ -136,9 +135,6 @@ export interface ILicense {
136
135
  description?: string;
137
136
  url?: string;
138
137
  }
139
- export interface INDLADate {
140
- underlying: string;
141
- }
142
138
  export interface INewConcept {
143
139
  language: string;
144
140
  title: string;
package/build/draft-api.d.ts CHANGED
@@ -1,25 +1,4 @@
1
1
  export type Availability = ("decoder" | "encoder" | "everyone" | "teacher");
2
- export interface IAgreement {
3
- id: number;
4
- title: string;
5
- content: string;
6
- copyright: ICopyright;
7
- created: INDLADate;
8
- updated: INDLADate;
9
- updatedBy: string;
10
- }
11
- export interface IAgreementSearchResult {
12
- totalCount: number;
13
- page?: number;
14
- pageSize: number;
15
- language: string;
16
- results: IAgreementSummary[];
17
- }
18
- export interface IAgreementSummary {
19
- id: number;
20
- title: string;
21
- license: string;
22
- }
23
2
  export interface IArticle {
24
3
  id: number;
25
4
  oldNdlaUrl?: string;
@@ -34,10 +13,10 @@ export interface IArticle {
34
13
  introduction?: IArticleIntroduction;
35
14
  metaDescription?: IArticleMetaDescription;
36
15
  metaImage?: IArticleMetaImage;
37
- created: INDLADate;
38
- updated: INDLADate;
16
+ created: string;
17
+ updated: string;
39
18
  updatedBy: string;
40
- published: INDLADate;
19
+ published: string;
41
20
  articleType: string;
42
21
  supportedLanguages: string[];
43
22
  notes: IEditorNote[];
@@ -84,7 +63,7 @@ export interface IArticleSummary {
84
63
  users: string[];
85
64
  grepCodes: string[];
86
65
  status: IStatus;
87
- updated: INDLADate;
66
+ updated: string;
88
67
  }
89
68
  export interface IArticleTag {
90
69
  tags: string[];
@@ -101,8 +80,8 @@ export interface IAuthor {
101
80
  export interface IComment {
102
81
  id: string;
103
82
  content: string;
104
- created: INDLADate;
105
- updated: INDLADate;
83
+ created: string;
84
+ updated: string;
106
85
  isOpen: boolean;
107
86
  }
108
87
  export interface ICopyright {
@@ -111,19 +90,18 @@ export interface ICopyright {
111
90
  creators: IAuthor[];
112
91
  processors: IAuthor[];
113
92
  rightsholders: IAuthor[];
114
- agreementId?: number;
115
- validFrom?: INDLADate;
116
- validTo?: INDLADate;
93
+ validFrom?: string;
94
+ validTo?: string;
117
95
  }
118
96
  export interface IDraftResponsible {
119
97
  responsibleId: string;
120
- lastUpdated: INDLADate;
98
+ lastUpdated: string;
121
99
  }
122
100
  export interface IEditorNote {
123
101
  note: string;
124
102
  user: string;
125
103
  status: IStatus;
126
- timestamp: INDLADate;
104
+ timestamp: string;
127
105
  }
128
106
  export interface IGrepCodesSearchResult {
129
107
  totalCount: number;
@@ -136,28 +114,10 @@ export interface ILicense {
136
114
  description?: string;
137
115
  url?: string;
138
116
  }
139
- export interface INDLADate {
140
- underlying: string;
141
- }
142
- export interface INewAgreement {
143
- title: string;
144
- content: string;
145
- copyright: INewAgreementCopyright;
146
- }
147
- export interface INewAgreementCopyright {
148
- license?: ILicense;
149
- origin?: string;
150
- creators: IAuthor[];
151
- processors: IAuthor[];
152
- rightsholders: IAuthor[];
153
- agreementId?: number;
154
- validFrom?: string;
155
- validTo?: string;
156
- }
157
117
  export interface INewArticle {
158
118
  language: string;
159
119
  title: string;
160
- published?: INDLADate;
120
+ published?: string;
161
121
  content?: string;
162
122
  tags: string[];
163
123
  introduction?: string;
@@ -198,7 +158,7 @@ export interface IRequiredLibrary {
198
158
  }
199
159
  export interface IRevisionMeta {
200
160
  id?: string;
201
- revisionDate: INDLADate;
161
+ revisionDate: string;
202
162
  note: string;
203
163
  status: string;
204
164
  }
@@ -220,17 +180,12 @@ export interface ITagsSearchResult {
220
180
  language: string;
221
181
  results: string[];
222
182
  }
223
- export interface IUpdatedAgreement {
224
- title?: string;
225
- content?: string;
226
- copyright?: INewAgreementCopyright;
227
- }
228
183
  export interface IUpdatedArticle {
229
184
  revision: number;
230
185
  language?: string;
231
186
  title?: string;
232
187
  status?: string;
233
- published?: INDLADate;
188
+ published?: string;
234
189
  content?: string;
235
190
  tags?: string[];
236
191
  introduction?: string;
package/build/frontpage-api.d.ts CHANGED
@@ -18,7 +18,7 @@ export interface IBannerImage {
18
18
  export interface IErrorBody {
19
19
  code: string;
20
20
  description: string;
21
- occurredAt: INDLADate;
21
+ occurredAt: string;
22
22
  statusCode: number;
23
23
  }
24
24
  export interface IFilmFrontPageData {
@@ -44,9 +44,6 @@ export interface IMovieThemeName {
44
44
  name: string;
45
45
  language: string;
46
46
  }
47
- export interface INDLADate {
48
- underlying: string;
49
- }
50
47
  export interface INewOrUpdateBannerImage {
51
48
  mobileImageId?: number;
52
49
  desktopImageId: number;
package/build/image-api.d.ts CHANGED
@@ -9,11 +9,11 @@ export interface ICopyright {
9
9
  processors: IAuthor[];
10
10
  rightsholders: IAuthor[];
11
11
  agreementId?: number;
12
- validFrom?: INDLADate;
13
- validTo?: INDLADate;
12
+ validFrom?: string;
13
+ validTo?: string;
14
14
  }
15
15
  export interface IEditorNote {
16
- timestamp: INDLADate;
16
+ timestamp: string;
17
17
  updatedBy: string;
18
18
  note: string;
19
19
  }
@@ -54,7 +54,7 @@ export interface IImageMetaInformationV2 {
54
54
  tags: IImageTag;
55
55
  caption: IImageCaption;
56
56
  supportedLanguages: string[];
57
- created: INDLADate;
57
+ created: string;
58
58
  createdBy: string;
59
59
  modelRelease: string;
60
60
  editorNotes?: IEditorNote[];
@@ -69,7 +69,7 @@ export interface IImageMetaInformationV3 {
69
69
  tags: IImageTag;
70
70
  caption: IImageCaption;
71
71
  supportedLanguages: string[];
72
- created: INDLADate;
72
+ created: string;
73
73
  createdBy: string;
74
74
  modelRelease: string;
75
75
  editorNotes?: IEditorNote[];
@@ -87,7 +87,7 @@ export interface IImageMetaSummary {
87
87
  supportedLanguages: string[];
88
88
  modelRelease?: string;
89
89
  editorNotes?: string[];
90
- lastUpdated: INDLADate;
90
+ lastUpdated: string;
91
91
  fileSize: number;
92
92
  contentType: string;
93
93
  imageDimensions?: IImageDimensions;
@@ -105,9 +105,6 @@ export interface ILicense {
105
105
  description: string;
106
106
  url?: string;
107
107
  }
108
- export interface INDLADate {
109
- underlying: string;
110
- }
111
108
  export interface INewImageMetaInformationV2 {
112
109
  title: string;
113
110
  alttext?: string;
package/build/learningpath-api.d.ts CHANGED
@@ -9,7 +9,7 @@ export interface IBreadcrumb {
9
9
  export interface IConfigMeta {
10
10
  key: string;
11
11
  value: string;
12
- updatedAt: INDLADate;
12
+ updatedAt: string;
13
13
  updatedBy: string;
14
14
  }
15
15
  export interface IConfigMetaRestricted {
@@ -46,9 +46,9 @@ export interface IFolder {
46
46
  subfolders: IFolderData[];
47
47
  resources: IResource[];
48
48
  rank?: number;
49
- created: INDLADate;
50
- updated: INDLADate;
51
- shared?: INDLADate;
49
+ created: string;
50
+ updated: string;
51
+ shared?: string;
52
52
  description?: string;
53
53
  }
54
54
  export type IFolderData = IFolder;
@@ -69,7 +69,7 @@ export interface ILearningPathSummaryV2 {
69
69
  coverPhotoUrl?: string;
70
70
  duration?: number;
71
71
  status: string;
72
- lastUpdated: INDLADate;
72
+ lastUpdated: string;
73
73
  tags: ILearningPathTags;
74
74
  copyright: ICopyright;
75
75
  supportedLanguages: string[];
@@ -98,7 +98,7 @@ export interface ILearningPathV2 {
98
98
  duration?: number;
99
99
  status: string;
100
100
  verificationStatus: string;
101
- lastUpdated: INDLADate;
101
+ lastUpdated: string;
102
102
  tags: ILearningPathTags;
103
103
  copyright: ICopyright;
104
104
  canEdit: boolean;
@@ -146,7 +146,7 @@ export interface ILicense {
146
146
  }
147
147
  export interface IMessage {
148
148
  message: string;
149
- date: INDLADate;
149
+ date: string;
150
150
  }
151
151
  export interface IMyNDLAUser {
152
152
  id: number;
@@ -154,9 +154,6 @@ export interface IMyNDLAUser {
154
154
  role: string;
155
155
  organization: string;
156
156
  }
157
- export interface INDLADate {
158
- underlying: string;
159
- }
160
157
  export interface INewFolder {
161
158
  name: string;
162
159
  parentId?: string;
@@ -173,7 +170,7 @@ export interface IResource {
173
170
  id: string;
174
171
  resourceType: string;
175
172
  path: string;
176
- created: INDLADate;
173
+ created: string;
177
174
  tags: string[];
178
175
  resourceId: string;
179
176
  rank?: number;
package/build/search-api.d.ts CHANGED
@@ -52,13 +52,13 @@ export interface IAudioResults {
52
52
  export interface IComment {
53
53
  id: string;
54
54
  content: string;
55
- created: INDLADate;
56
- updated: INDLADate;
55
+ created: string;
56
+ updated: string;
57
57
  isOpen: boolean;
58
58
  }
59
59
  export interface IDraftResponsible {
60
60
  responsibleId: string;
61
- lastUpdated: INDLADate;
61
+ lastUpdated: string;
62
62
  }
63
63
  export interface IGroupSearchResult {
64
64
  totalCount: number;
@@ -148,7 +148,7 @@ export interface IMultiSearchSummary {
148
148
  score: number;
149
149
  highlights: IHighlightedField[];
150
150
  paths: string[];
151
- lastUpdated: INDLADate;
151
+ lastUpdated: string;
152
152
  license?: string;
153
153
  revisions: IRevisionMeta[];
154
154
  responsible?: IDraftResponsible;
@@ -161,11 +161,8 @@ export interface IMultiSearchTermsAggregation {
161
161
  docCountErrorUpperBound: number;
162
162
  values: ITermValue[];
163
163
  }
164
- export interface INDLADate {
165
- underlying: string;
166
- }
167
164
  export interface IRevisionMeta {
168
- revisionDate: INDLADate;
165
+ revisionDate: string;
169
166
  note: string;
170
167
  status: string;
171
168
  }
package/package.json CHANGED
@@ -26,5 +26,5 @@
26
26
  "devDependencies": {
27
27
  "typescript": "^5.0.2"
28
28
  },
29
- "version": "0.2.18"
29
+ "version": "0.2.20"
30
30
  }