@ndla/types-taxonomy 1.0.24 → 1.0.26

package/build/taxonomy-api.d.ts

@@ -13,6 +13,10 @@ export interface Context {
 export interface ContextPOST {
     id: string;
 }
+export interface GradeAverage {
+    averageValue: number;
+    count: number;
+}
 export interface Metadata {
     customFields: Record<string, string>;
     grepCodes: string[];
@@ -27,6 +31,10 @@ export interface Node {
      */
     contextId?: string;
     contexts: TaxonomyContext[];
+    /**
+     * A number representing the average grade of all children nodes recursively.
+     */
+    gradeAverage?: GradeAverage;
     id: string;
     language: string;
     metadata: Metadata;
@@ -37,6 +45,10 @@ export interface Node {
     nodeType: NodeType;
     path: string;
     paths: string[];
+    /**
+     * Quality evaluation of the article
+     */
+    qualityEvaluation?: QualityEvaluation;
     relevanceId?: string;
     resourceTypes: ResourceTypeWithConnection[];
     supportedLanguages: string[];
@@ -138,6 +150,10 @@ export interface NodePostPut {
      * Type of node.
      */
     nodeType: NodeType;
+    /**
+     * The quality evaluation of the node. Consist of a score from 1 to 5 and a comment.
+     */
+    qualityEvaluation?: QualityEvaluation | null;
     /**
      * The node is a root node. Default is false. Only used if present.
      * @deprecated
@@ -256,6 +272,10 @@ export interface NodeSearchBody {
 export interface NodeWithParents extends Node {
     parents: NodeChild[];
 }
+export interface QualityEvaluation {
+    grade: Grade;
+    note?: string;
+}
 export interface Relevance {
     /**
      * Specifies if node is core or supplementary
@@ -494,6 +514,10 @@ export interface TaxonomyContext {
      * Whether the parent connection is visible or not
      */
     isVisible: boolean;
+    /**
+     * List of all parent contextIds
+     */
+    parentContextIds: string[];
     /**
      * List of all parent ids
      */
@@ -731,5 +755,6 @@ export interface VersionPostPut {
     name: string;
 }
 export type DateAsString = string;
+export type Grade = 1 | 2 | 3 | 4 | 5;
 export type NodeType = "NODE" | "SUBJECT" | "TOPIC" | "RESOURCE" | "PROGRAMME";
 export type VersionType = "BETA" | "PUBLISHED" | "ARCHIVED";

package/package.json

@@ -17,5 +17,5 @@
   "devDependencies": {
     "typescript": "^5.0.2"
   },
-  "version": "1.0.24"
+  "version": "1.0.26"
 }

package/taxonomy-api.ts

@@ -17,6 +17,11 @@ export interface ContextPOST {
     id: string;
 }
 
+export interface GradeAverage {
+    averageValue: number;
+    count: number;
+}
+
 export interface Metadata {
     customFields: Record<string, string>;
     grepCodes: string[];
@@ -32,6 +37,10 @@ export interface Node {
      */
     contextId?: string;
     contexts: TaxonomyContext[];
+    /**
+     * A number representing the average grade of all children nodes recursively.
+     */
+    gradeAverage?: GradeAverage;
     id: string;
     language: string;
     metadata: Metadata;
@@ -42,6 +51,10 @@ export interface Node {
     nodeType: NodeType;
     path: string;
     paths: string[];
+    /**
+     * Quality evaluation of the article
+     */
+    qualityEvaluation?: QualityEvaluation;
     relevanceId?: string;
     resourceTypes: ResourceTypeWithConnection[];
     supportedLanguages: string[];
@@ -148,6 +161,10 @@ export interface NodePostPut {
      * Type of node.
      */
     nodeType: NodeType;
+    /**
+     * The quality evaluation of the node. Consist of a score from 1 to 5 and a comment.
+     */
+    qualityEvaluation?: QualityEvaluation | null;
     /**
      * The node is a root node. Default is false. Only used if present.
      * @deprecated
@@ -272,6 +289,11 @@ export interface NodeWithParents extends Node {
     parents: NodeChild[];
 }
 
+export interface QualityEvaluation {
+    grade: Grade;
+    note?: string;
+}
+
 export interface Relevance {
     /**
      * Specifies if node is core or supplementary
@@ -526,6 +548,10 @@ export interface TaxonomyContext {
      * Whether the parent connection is visible or not
      */
     isVisible: boolean;
+    /**
+     * List of all parent contextIds
+     */
+    parentContextIds: string[];
     /**
      * List of all parent ids
      */
@@ -777,6 +803,8 @@ export interface VersionPostPut {
 
 export type DateAsString = string;
 
+export type Grade = 1 | 2 | 3 | 4 | 5;
+
 export type NodeType = "NODE" | "SUBJECT" | "TOPIC" | "RESOURCE" | "PROGRAMME";
 
 export type VersionType = "BETA" | "PUBLISHED" | "ARCHIVED";