@ndla/types-backend 0.2.17 → 0.2.18

package/build/article-api.d.ts

@@ -1,4 +1,4 @@
-export type Availability = ("everyone" | "teacher");
+export type Availability = ("decoder" | "encoder" | "everyone" | "teacher");
 export interface IArticleContentV2 {
     content: string;
     language: string;
@@ -33,12 +33,12 @@ export interface IArticleSearchParams {
     license?: string;
     page?: number;
     pageSize?: number;
-    idList: number[];
-    articleTypes: string[];
+    idList?: number[];
+    articleTypes?: string[];
     sort?: string;
     fallback?: boolean;
     scrollId?: string;
-    grepCodes: string[];
+    grepCodes?: string[];
 }
 export interface IArticleSummaryV2 {
     id: number;
@@ -50,7 +50,7 @@ export interface IArticleSummaryV2 {
     url: string;
     license: string;
     articleType: string;
-    lastUpdated: string;
+    lastUpdated: INDLADate;
     supportedLanguages: string[];
     grepCodes: string[];
     availability: string;
@@ -76,17 +76,17 @@ export interface IArticleV2 {
     metaImage?: IArticleMetaImage;
     introduction?: IArticleIntroduction;
     metaDescription: IArticleMetaDescription;
-    created: string;
-    updated: string;
+    created: INDLADate;
+    updated: INDLADate;
     updatedBy: string;
-    published: string;
+    published: INDLADate;
     articleType: string;
     supportedLanguages: string[];
     grepCodes: string[];
     conceptIds: number[];
     availability: string;
     relatedContent: (IRelatedContentLink | number)[];
-    revisionDate?: string;
+    revisionDate?: INDLADate;
     slug?: string;
 }
 export interface IAuthor {
@@ -100,22 +100,16 @@ export interface ICopyright {
     processors: IAuthor[];
     rightsholders: IAuthor[];
     agreementId?: number;
-    validFrom?: string;
-    validTo?: string;
+    validFrom?: INDLADate;
+    validTo?: INDLADate;
 }
 export interface ILicense {
     license: string;
     description?: string;
     url?: string;
 }
-export interface IPartialPublishArticle {
-    availability?: Availability;
-    grepCodes?: string[];
-    license?: string;
-    metaDescription?: IArticleMetaDescription[];
-    relatedContent?: (IRelatedContentLink | number)[];
-    tags?: IArticleTag[];
-    revisionDate?: (NullAlias | string);
+export interface INDLADate {
+    underlying: string;
 }
 export interface IRelatedContentLink {
     title: string;
@@ -154,4 +148,3 @@ export interface IVisualElement {
     visualElement: string;
     language: string;
 }
-export type NullAlias = null;

package/build/audio-api.d.ts

@@ -16,8 +16,8 @@ export interface IAudioMetaInformation {
     podcastMeta?: IPodcastMeta;
     series?: ISeries;
     manuscript?: IManuscript;
-    created: string;
-    updated: string;
+    created: INDLADate;
+    updated: INDLADate;
 }
 export interface IAudioSummary {
     id: number;
@@ -29,7 +29,7 @@ export interface IAudioSummary {
     manuscript?: IManuscript;
     podcastMeta?: IPodcastMeta;
     series?: ISeriesSummary;
-    lastUpdated: string;
+    lastUpdated: INDLADate;
 }
 export interface IAudioSummarySearchResult {
     totalCount: number;
@@ -49,8 +49,8 @@ export interface ICopyright {
     processors: IAuthor[];
     rightsholders: IAuthor[];
     agreementId?: number;
-    validFrom?: string;
-    validTo?: string;
+    validFrom?: INDLADate;
+    validTo?: INDLADate;
 }
 export interface ICoverPhoto {
     id: string;
@@ -70,6 +70,9 @@ export interface IManuscript {
     manuscript: string;
     language: string;
 }
+export interface INDLADate {
+    underlying: string;
+}
 export interface INewAudioMetaInformation {
     title: string;
     language: string;

package/build/concept-api.d.ts

@@ -12,8 +12,8 @@ export interface IConcept {
     metaImage?: IConceptMetaImage;
     tags?: IConceptTags;
     subjectIds?: string[];
-    created: string;
-    updated: string;
+    created: INDLADate;
+    updated: INDLADate;
     updatedBy?: string[];
     supportedLanguages: string[];
     articleIds: number[];
@@ -34,7 +34,7 @@ export interface IConceptMetaImage {
 }
 export interface IConceptResponsible {
     responsibleId: string;
-    lastUpdated: string;
+    lastUpdated: INDLADate;
 }
 export interface IConceptSearchParams {
     query?: string;
@@ -67,8 +67,8 @@ export interface IConceptSummary {
     tags?: IConceptTags;
     subjectIds?: string[];
     supportedLanguages: string[];
-    lastUpdated: string;
-    created: string;
+    lastUpdated: INDLADate;
+    created: INDLADate;
     status: IStatus;
     updatedBy: string[];
     license?: string;
@@ -94,8 +94,8 @@ export interface ICopyright {
     processors: IAuthor[];
     rightsholders: IAuthor[];
     agreementId?: number;
-    validFrom?: string;
-    validTo?: string;
+    validFrom?: INDLADate;
+    validTo?: INDLADate;
 }
 export interface IDraftConceptSearchParams {
     query?: string;
@@ -136,6 +136,9 @@ export interface ILicense {
     description?: string;
     url?: string;
 }
+export interface INDLADate {
+    underlying: string;
+}
 export interface INewConcept {
     language: string;
     title: string;

package/build/draft-api.d.ts

@@ -1,11 +1,11 @@
-export type Availability = ("everyone" | "teacher");
+export type Availability = ("decoder" | "encoder" | "everyone" | "teacher");
 export interface IAgreement {
     id: number;
     title: string;
     content: string;
     copyright: ICopyright;
-    created: string;
-    updated: string;
+    created: INDLADate;
+    updated: INDLADate;
     updatedBy: string;
 }
 export interface IAgreementSearchResult {
@@ -34,10 +34,10 @@ export interface IArticle {
     introduction?: IArticleIntroduction;
     metaDescription?: IArticleMetaDescription;
     metaImage?: IArticleMetaImage;
-    created: string;
-    updated: string;
+    created: INDLADate;
+    updated: INDLADate;
     updatedBy: string;
-    published: string;
+    published: INDLADate;
     articleType: string;
     supportedLanguages: string[];
     notes: IEditorNote[];
@@ -84,7 +84,7 @@ export interface IArticleSummary {
     users: string[];
     grepCodes: string[];
     status: IStatus;
-    updated: string;
+    updated: INDLADate;
 }
 export interface IArticleTag {
     tags: string[];
@@ -101,8 +101,8 @@ export interface IAuthor {
 export interface IComment {
     id: string;
     content: string;
-    created: string;
-    updated: string;
+    created: INDLADate;
+    updated: INDLADate;
     isOpen: boolean;
 }
 export interface ICopyright {
@@ -112,18 +112,18 @@ export interface ICopyright {
     processors: IAuthor[];
     rightsholders: IAuthor[];
     agreementId?: number;
-    validFrom?: string;
-    validTo?: string;
+    validFrom?: INDLADate;
+    validTo?: INDLADate;
 }
 export interface IDraftResponsible {
     responsibleId: string;
-    lastUpdated: string;
+    lastUpdated: INDLADate;
 }
 export interface IEditorNote {
     note: string;
     user: string;
     status: IStatus;
-    timestamp: string;
+    timestamp: INDLADate;
 }
 export interface IGrepCodesSearchResult {
     totalCount: number;
@@ -136,6 +136,9 @@ export interface ILicense {
     description?: string;
     url?: string;
 }
+export interface INDLADate {
+    underlying: string;
+}
 export interface INewAgreement {
     title: string;
     content: string;
@@ -154,7 +157,7 @@ export interface INewAgreementCopyright {
 export interface INewArticle {
     language: string;
     title: string;
-    published?: string;
+    published?: INDLADate;
     content?: string;
     tags: string[];
     introduction?: string;
@@ -195,7 +198,7 @@ export interface IRequiredLibrary {
 }
 export interface IRevisionMeta {
     id?: string;
-    revisionDate: string;
+    revisionDate: INDLADate;
     note: string;
     status: string;
 }
@@ -227,7 +230,7 @@ export interface IUpdatedArticle {
     language?: string;
     title?: string;
     status?: string;
-    published?: string;
+    published?: INDLADate;
     content?: string;
     tags?: string[];
     introduction?: string;

package/build/frontpage-api.d.ts

@@ -18,8 +18,7 @@ export interface IBannerImage {
 export interface IErrorBody {
     code: string;
     description: string;
-    occurredAt: string;
-    messages?: IValidationMessage[];
+    occurredAt: INDLADate;
     statusCode: number;
 }
 export interface IFilmFrontPageData {
@@ -45,6 +44,9 @@ export interface IMovieThemeName {
     name: string;
     language: string;
 }
+export interface INDLADate {
+    underlying: string;
+}
 export interface INewOrUpdateBannerImage {
     mobileImageId?: number;
     desktopImageId: number;
@@ -127,10 +129,6 @@ export interface IUpdatedSubjectFrontPageData {
     latestContent?: string[];
     goTo?: string[];
 }
-export interface IValidationMessage {
-    field: string;
-    message: string;
-}
 export interface IVisualElement {
     type: string;
     url: string;

package/build/image-api.d.ts

@@ -9,11 +9,11 @@ export interface ICopyright {
     processors: IAuthor[];
     rightsholders: IAuthor[];
     agreementId?: number;
-    validFrom?: string;
-    validTo?: string;
+    validFrom?: INDLADate;
+    validTo?: INDLADate;
 }
 export interface IEditorNote {
-    timestamp: string;
+    timestamp: INDLADate;
     updatedBy: string;
     note: string;
 }
@@ -54,7 +54,7 @@ export interface IImageMetaInformationV2 {
     tags: IImageTag;
     caption: IImageCaption;
     supportedLanguages: string[];
-    created: string;
+    created: INDLADate;
     createdBy: string;
     modelRelease: string;
     editorNotes?: IEditorNote[];
@@ -69,7 +69,7 @@ export interface IImageMetaInformationV3 {
     tags: IImageTag;
     caption: IImageCaption;
     supportedLanguages: string[];
-    created: string;
+    created: INDLADate;
     createdBy: string;
     modelRelease: string;
     editorNotes?: IEditorNote[];
@@ -87,7 +87,7 @@ export interface IImageMetaSummary {
     supportedLanguages: string[];
     modelRelease?: string;
     editorNotes?: string[];
-    lastUpdated: string;
+    lastUpdated: INDLADate;
     fileSize: number;
     contentType: string;
     imageDimensions?: IImageDimensions;
@@ -105,6 +105,9 @@ export interface ILicense {
     description: string;
     url?: string;
 }
+export interface INDLADate {
+    underlying: string;
+}
 export interface INewImageMetaInformationV2 {
     title: string;
     alttext?: string;

package/build/learningpath-api.d.ts

@@ -9,7 +9,7 @@ export interface IBreadcrumb {
 export interface IConfigMeta {
     key: string;
     value: string;
-    updatedAt: string;
+    updatedAt: INDLADate;
     updatedBy: string;
 }
 export interface IConfigMetaRestricted {
@@ -46,9 +46,9 @@ export interface IFolder {
     subfolders: IFolderData[];
     resources: IResource[];
     rank?: number;
-    created: string;
-    updated: string;
-    shared?: string;
+    created: INDLADate;
+    updated: INDLADate;
+    shared?: INDLADate;
     description?: string;
 }
 export type IFolderData = IFolder;
@@ -69,7 +69,7 @@ export interface ILearningPathSummaryV2 {
     coverPhotoUrl?: string;
     duration?: number;
     status: string;
-    lastUpdated: string;
+    lastUpdated: INDLADate;
     tags: ILearningPathTags;
     copyright: ICopyright;
     supportedLanguages: string[];
@@ -98,7 +98,7 @@ export interface ILearningPathV2 {
     duration?: number;
     status: string;
     verificationStatus: string;
-    lastUpdated: string;
+    lastUpdated: INDLADate;
     tags: ILearningPathTags;
     copyright: ICopyright;
     canEdit: boolean;
@@ -146,7 +146,7 @@ export interface ILicense {
 }
 export interface IMessage {
     message: string;
-    date: string;
+    date: INDLADate;
 }
 export interface IMyNDLAUser {
     id: number;
@@ -154,6 +154,9 @@ export interface IMyNDLAUser {
     role: string;
     organization: string;
 }
+export interface INDLADate {
+    underlying: string;
+}
 export interface INewFolder {
     name: string;
     parentId?: string;
@@ -170,7 +173,7 @@ export interface IResource {
     id: string;
     resourceType: string;
     path: string;
-    created: string;
+    created: INDLADate;
     tags: string[];
     resourceId: string;
     rank?: number;

package/build/search-api.d.ts

@@ -52,13 +52,13 @@ export interface IAudioResults {
 export interface IComment {
     id: string;
     content: string;
-    created: string;
-    updated: string;
+    created: INDLADate;
+    updated: INDLADate;
     isOpen: boolean;
 }
 export interface IDraftResponsible {
     responsibleId: string;
-    lastUpdated: string;
+    lastUpdated: INDLADate;
 }
 export interface IGroupSearchResult {
     totalCount: number;
@@ -148,7 +148,7 @@ export interface IMultiSearchSummary {
     score: number;
     highlights: IHighlightedField[];
     paths: string[];
-    lastUpdated: string;
+    lastUpdated: INDLADate;
     license?: string;
     revisions: IRevisionMeta[];
     responsible?: IDraftResponsible;
@@ -161,8 +161,11 @@ export interface IMultiSearchTermsAggregation {
     docCountErrorUpperBound: number;
     values: ITermValue[];
 }
+export interface INDLADate {
+    underlying: string;
+}
 export interface IRevisionMeta {
-    revisionDate: string;
+    revisionDate: INDLADate;
     note: string;
     status: string;
 }

package/package.json

@@ -26,5 +26,5 @@
     "devDependencies": {
         "typescript": "^5.0.2"
     },
-    "version": "0.2.17"
+    "version": "0.2.18"
 }