@ndla/types-taxonomy 1.0.16 → 1.0.18

package/build/taxonomy-api.d.ts

@@ -119,6 +119,10 @@ export interface NodePostPut {
      * ID of content introducing this node. Must be a valid URI, but preferably not a URL.
      */
     contentUri?: string;
+    /**
+     * The node is the root in a context. Default is false. Only used if present.
+     */
+    context?: boolean;
     /**
      * The name of the node. Required on create.
      */
@@ -130,6 +134,7 @@ export interface NodePostPut {
     nodeType: NodeType;
     /**
      * The node is a root node. Default is false. Only used if present.
+     * @deprecated
      */
     root?: boolean;
     /**
@@ -417,11 +422,15 @@ export interface SubjectTopicPUT {
 }
 export interface TaxonomyContext {
     /**
-     * A breadcrumb of the names of the context's path
+     * A breadcrumb of the names of the context's parents
      */
     breadcrumbs: Record<string, string[]>;
     /**
-     * Unique id of context based on root + connection
+     * The id of the parent connection object
+     */
+    connectionId: string;
+    /**
+     * Unique id of context based on root + parent connection
      */
     contextId: string;
     /**
@@ -433,11 +442,11 @@ export interface TaxonomyContext {
      */
     id?: string;
     /**
-     * Whether the base connection is marked as active subject
+     * Whether the parent connection is marked as active
      */
     isActive: boolean;
     /**
-     * Whether the base connection is primary or not
+     * Whether the parent connection is primary or not
      */
     isPrimary: boolean;
     /**
@@ -445,11 +454,11 @@ export interface TaxonomyContext {
      */
     isPrimaryConnection?: boolean;
     /**
-     * Whether the base connection is visible or not
+     * Whether the parent connection is visible or not
      */
     isVisible: boolean;
     /**
-     * List of all parent topic-ids
+     * List of all parent ids
      */
     parentIds: string[];
     /**
@@ -465,15 +474,19 @@ export interface TaxonomyContext {
      */
     publicId: string;
     /**
-     * Name of the relevance of the connection of the base
+     * The rank of the parent connection object
+     */
+    rank: number;
+    /**
+     * Name of the relevance of the parent connection
      */
     relevance: Record<string, string>;
     /**
-     * Id of the relevance of the connection of the base
+     * Id of the relevance of the parent connection
      */
     relevanceId?: string;
     /**
-     * Resource-types of the base
+     * Resource-types of the node
      */
     resourceTypes: SearchableTaxonomyResourceType[];
     /**
@@ -492,6 +505,10 @@ export interface TaxonomyContext {
      * @deprecated
      */
     subjectId?: string;
+    /**
+     * Pretty-url of this particular context
+     */
+    url?: string;
 }
 export interface TopicPostPut {
     /**
@@ -689,5 +706,5 @@ export interface VersionPostPut {
     name: string;
 }
 export type DateAsString = string;
-export type NodeType = "NODE" | "SUBJECT" | "TOPIC" | "RESOURCE";
+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.16"
+  "version": "1.0.18"
 }

package/taxonomy-api.ts

@@ -129,6 +129,10 @@ export interface NodePostPut {
      * ID of content introducing this node. Must be a valid URI, but preferably not a URL.
      */
     contentUri?: string;
+    /**
+     * The node is the root in a context. Default is false. Only used if present.
+     */
+    context?: boolean;
     /**
      * The name of the node. Required on create.
      */
@@ -140,6 +144,7 @@ export interface NodePostPut {
     nodeType: NodeType;
     /**
      * The node is a root node. Default is false. Only used if present.
+     * @deprecated
      */
     root?: boolean;
     /**
@@ -448,11 +453,15 @@ export interface SubjectTopicPUT {
 
 export interface TaxonomyContext {
     /**
-     * A breadcrumb of the names of the context's path
+     * A breadcrumb of the names of the context's parents
      */
     breadcrumbs: Record<string, string[]>;
     /**
-     * Unique id of context based on root + connection
+     * The id of the parent connection object
+     */
+    connectionId: string;
+    /**
+     * Unique id of context based on root + parent connection
      */
     contextId: string;
     /**
@@ -464,11 +473,11 @@ export interface TaxonomyContext {
      */
     id?: string;
     /**
-     * Whether the base connection is marked as active subject
+     * Whether the parent connection is marked as active
      */
     isActive: boolean;
     /**
-     * Whether the base connection is primary or not
+     * Whether the parent connection is primary or not
      */
     isPrimary: boolean;
     /**
@@ -476,11 +485,11 @@ export interface TaxonomyContext {
      */
     isPrimaryConnection?: boolean;
     /**
-     * Whether the base connection is visible or not
+     * Whether the parent connection is visible or not
      */
     isVisible: boolean;
     /**
-     * List of all parent topic-ids
+     * List of all parent ids
      */
     parentIds: string[];
     /**
@@ -496,15 +505,19 @@ export interface TaxonomyContext {
      */
     publicId: string;
     /**
-     * Name of the relevance of the connection of the base
+     * The rank of the parent connection object
+     */
+    rank: number;
+    /**
+     * Name of the relevance of the parent connection
      */
     relevance: Record<string, string>;
     /**
-     * Id of the relevance of the connection of the base
+     * Id of the relevance of the parent connection
      */
     relevanceId?: string;
     /**
-     * Resource-types of the base
+     * Resource-types of the node
      */
     resourceTypes: SearchableTaxonomyResourceType[];
     /**
@@ -523,6 +536,10 @@ export interface TaxonomyContext {
      * @deprecated
      */
     subjectId?: string;
+    /**
+     * Pretty-url of this particular context
+     */
+    url?: string;
 }
 
 export interface TopicPostPut {
@@ -734,6 +751,6 @@ export interface VersionPostPut {
 
 export type DateAsString = string;
 
-export type NodeType = "NODE" | "SUBJECT" | "TOPIC" | "RESOURCE";
+export type NodeType = "NODE" | "SUBJECT" | "TOPIC" | "RESOURCE" | "PROGRAMME";
 
 export type VersionType = "BETA" | "PUBLISHED" | "ARCHIVED";