@ndla/types-backend 0.2.39 → 0.2.41

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;

package/build/concept-api.d.ts

@@ -1,4 +1,3 @@
-export type Either = (ILeft | IRight);
 export interface IAuthor {
     type: string;
     name: string;
@@ -140,10 +139,6 @@ export interface IGlossExample {
         [key: string]: string;
     };
 }
-export interface ILeft {
-    value: "Could not find TSType[A] in scope and could not generate it";
-    type: "Left";
-}
 export interface ILicense {
     license: string;
     description?: string;
@@ -167,10 +162,6 @@ export interface INewConceptMetaImage {
     id: string;
     alt: string;
 }
-export interface IRight {
-    value: "Could not find TSType[B] in scope and could not generate it";
-    type: "Right";
-}
 export interface IStatus {
     current: string;
     other: string[];
@@ -191,14 +182,14 @@ export interface IUpdatedConcept {
     language: string;
     title?: string;
     content?: string;
-    metaImage: Either;
+    metaImage?: (null | INewConceptMetaImage);
     copyright?: IDraftCopyright;
     tags?: string[];
     subjectIds?: string[];
     articleIds?: number[];
     status?: string;
     visualElement?: string;
-    responsibleId: Either;
+    responsibleId?: (null | string);
     conceptType?: string;
     glossData?: IGlossData;
 }

package/build/draft-api.d.ts

@@ -1,5 +1,4 @@
-export type Availability = ("everyone" | "teacher");
-export type Either = (ILeft | IRight);
+export type Availability = ("decoder" | "encoder" | "everyone" | "teacher");
 export interface IArticle {
     id: number;
     oldNdlaUrl?: string;
@@ -113,10 +112,6 @@ export interface IGrepCodesSearchResult {
     pageSize: number;
     results: string[];
 }
-export interface ILeft {
-    value: "Could not find TSType[A] in scope and could not generate it";
-    type: "Left";
-}
 export interface ILicense {
     license: string;
     description?: string;
@@ -171,10 +166,6 @@ export interface IRevisionMeta {
     note: string;
     status: string;
 }
-export interface IRight {
-    value: "Could not find TSType[B] in scope and could not generate it";
-    type: "Right";
-}
 export interface ISearchResult {
     totalCount: number;
     page: number;
@@ -203,7 +194,7 @@ export interface IUpdatedArticle {
     tags?: string[];
     introduction?: string;
     metaDescription?: string;
-    metaImage: Either;
+    metaImage?: (null | INewArticleMetaImage);
     visualElement?: string;
     copyright?: IDraftCopyright;
     requiredLibraries?: IRequiredLibrary[];
@@ -216,7 +207,7 @@ export interface IUpdatedArticle {
     availability?: string;
     relatedContent?: (IRelatedContentLink | number)[];
     revisionMeta?: IRevisionMeta[];
-    responsibleId: Either;
+    responsibleId?: (null | string);
     slug?: string;
     comments?: IUpdatedComment[];
     prioritized?: boolean;

package/build/image-api.d.ts

@@ -1,4 +1,3 @@
-export type Either = (ILeft | IRight);
 export interface IAuthor {
     type: string;
     name: string;
@@ -101,10 +100,6 @@ export interface IImageTitle {
     title: string;
     language: string;
 }
-export interface ILeft {
-    value: "Could not find TSType[A] in scope and could not generate it";
-    type: "Left";
-}
 export interface ILicense {
     license: string;
     description?: string;
@@ -119,10 +114,6 @@ export interface INewImageMetaInformationV2 {
     language: string;
     modelReleased?: string;
 }
-export interface IRight {
-    value: "Could not find TSType[B] in scope and could not generate it";
-    type: "Right";
-}
 export interface ISearchParams {
     query?: string;
     license?: string;
@@ -161,7 +152,7 @@ export interface ITagsSearchResult {
 export interface IUpdateImageMetaInformation {
     language: string;
     title?: string;
-    alttext: Either;
+    alttext?: (null | string);
     copyright?: ICopyright;
     tags?: string[];
     caption?: string;

package/build/myndla-api.d.ts

@@ -1,7 +1,38 @@
+export type ArenaGroup = "ADMIN";
+export interface IArenaUser {
+    id: number;
+    displayName: string;
+    username: string;
+    location: string;
+    groups: ArenaGroup[];
+}
 export interface IBreadcrumb {
     id: string;
     name: string;
 }
+export interface ICategory {
+    id: number;
+    title: string;
+    description: string;
+    topicCount: number;
+    postCount: number;
+    isFollowing: boolean;
+    visible: boolean;
+    rank: number;
+}
+export interface ICategoryWithTopics {
+    id: number;
+    title: string;
+    description: string;
+    topicCount: number;
+    postCount: number;
+    topicPage: number;
+    topicPageSize: number;
+    topics: ITopic[];
+    isFollowing: boolean;
+    visible: boolean;
+    rank: number;
+}
 export interface IConfigMeta {
     key: string;
     value: (boolean | string[]);
@@ -12,6 +43,14 @@ export interface IConfigMetaRestricted {
     key: string;
     value: (boolean | string[]);
 }
+export interface IFlag {
+    id: number;
+    reason: string;
+    created: string;
+    resolved?: string;
+    isResolved: boolean;
+    flagger: IArenaUser;
+}
 export interface IFolder {
     id: string;
     name: string;
@@ -46,6 +85,15 @@ export interface IMyNDLAUser {
     groups: IMyNDLAGroup[];
     arenaEnabled: boolean;
     shareName: boolean;
+    arenaGroups: ArenaGroup[];
+}
+export interface INewCategory {
+    title: string;
+    description: string;
+    visible: boolean;
+}
+export interface INewFlag {
+    reason: string;
 }
 export interface INewFolder {
     name: string;
@@ -53,15 +101,63 @@ export interface INewFolder {
     status?: string;
     description?: string;
 }
+export interface INewPost {
+    content: string;
+}
+export interface INewPostNotification {
+    id: number;
+    topicId: number;
+    isRead: boolean;
+    topicTitle: string;
+    post: IPost;
+    notificationTime: string;
+}
 export interface INewResource {
     resourceType: string;
     path: string;
     tags?: string[];
     resourceId: string;
 }
+export interface INewTopic {
+    title: string;
+    initialPost: INewPost;
+}
 export interface IOwner {
     name: string;
 }
+export interface IPaginatedArenaUsers {
+    totalCount: number;
+    page: number;
+    pageSize: number;
+    items: IArenaUser[];
+}
+export interface IPaginatedNewPostNotifications {
+    totalCount: number;
+    page: number;
+    pageSize: number;
+    items: INewPostNotification[];
+}
+export interface IPaginatedPosts {
+    totalCount: number;
+    page: number;
+    pageSize: number;
+    items: IPost[];
+}
+export interface IPaginatedTopics {
+    totalCount: number;
+    page: number;
+    pageSize: number;
+    items: ITopic[];
+}
+export interface IPost {
+    id: number;
+    content: string;
+    created: string;
+    updated: string;
+    owner: IArenaUser;
+    flags?: IFlag[];
+    topicId: number;
+}
 export interface IResource {
     id: string;
     resourceType: string;
@@ -71,11 +167,36 @@ export interface IResource {
     resourceId: string;
     rank?: number;
 }
+export interface ITopic {
+    id: number;
+    title: string;
+    postCount: number;
+    created: string;
+    updated: string;
+    categoryId: number;
+    isFollowing: boolean;
+}
+export interface ITopicWithPosts {
+    id: number;
+    title: string;
+    postCount: number;
+    posts: IPaginatedPosts;
+    created: string;
+    updated: string;
+    categoryId: number;
+    isFollowing: boolean;
+}
 export interface IUpdatedFolder {
     name?: string;
     status?: string;
     description?: string;
 }
+export interface IUpdatedMyNDLAUser {
+    favoriteSubjects?: string[];
+    arenaEnabled?: boolean;
+    shareName?: boolean;
+    arenaGroups?: ArenaGroup[];
+}
 export interface IUpdatedResource {
     tags?: string[];
     resourceId?: string;

package/package.json

@@ -27,5 +27,5 @@
     "devDependencies": {
         "typescript": "^5.0.2"
     },
-    "version": "0.2.39"
+    "version": "0.2.41"
 }