@ndla/types-taxonomy 1.0.17 → 1.0.19

package/build/taxonomy-api.d.ts

@@ -19,6 +19,7 @@ export interface Metadata {
     visible: boolean;
 }
 export interface Node {
+    baseName: string;
     breadcrumbs: string[];
     contentUri?: string;
     /**
@@ -27,6 +28,7 @@ export interface Node {
     contextId?: string;
     contexts: TaxonomyContext[];
     id: string;
+    language: string;
     metadata: Metadata;
     name: string;
     /**
@@ -422,11 +424,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;
     /**
@@ -438,11 +444,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;
     /**
@@ -450,11 +456,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[];
     /**
@@ -470,15 +476,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[];
     /**
@@ -497,6 +507,10 @@ export interface TaxonomyContext {
      * @deprecated
      */
     subjectId?: string;
+    /**
+     * Pretty-url of this particular context
+     */
+    url?: string;
 }
 export interface TopicPostPut {
     /**

package/package.json

@@ -17,5 +17,5 @@
   "devDependencies": {
     "typescript": "^5.0.2"
   },
-  "version": "1.0.17"
+  "version": "1.0.19"
 }

package/taxonomy-api.ts

@@ -24,6 +24,7 @@ export interface Metadata {
 }
 
 export interface Node {
+    baseName: string;
     breadcrumbs: string[];
     contentUri?: string;
     /**
@@ -32,6 +33,7 @@ export interface Node {
     contextId?: string;
     contexts: TaxonomyContext[];
     id: string;
+    language: string;
     metadata: Metadata;
     name: string;
     /**
@@ -453,11 +455,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;
     /**
@@ -469,11 +475,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;
     /**
@@ -481,11 +487,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[];
     /**
@@ -501,15 +507,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[];
     /**
@@ -528,6 +538,10 @@ export interface TaxonomyContext {
      * @deprecated
      */
     subjectId?: string;
+    /**
+     * Pretty-url of this particular context
+     */
+    url?: string;
 }
 
 export interface TopicPostPut {