@ndla/types-taxonomy 1.0.27 → 1.0.29

package/build/taxonomy-api.d.ts

@@ -26,9 +26,6 @@ export interface Node {
     baseName: string;
     breadcrumbs: string[];
     contentUri?: string;
-    /**
-     * The context object selected when fetching node
-     */
     context?: TaxonomyContext;
     /**
      * An id unique for this context.
@@ -289,21 +286,8 @@ export interface Relevance {
      * List of language codes supported by translations
      */
     supportedLanguages: string[];
-    /**
-     * All translations of this relevance
-     */
     translations: Translation[];
 }
-export interface RelevancePUT {
-    /**
-     * If specified, set the id to this value. Must start with urn:relevance: and be a valid URI. If ommitted, an id will be assigned automatically. Ignored on update
-     */
-    id: string;
-    /**
-     * The name of the relevance
-     */
-    name: string;
-}
 export interface ResolvedOldUrl {
     /**
      * URL path for resource
@@ -502,6 +486,10 @@ export interface TaxonomyContext {
      * Whether a 'standard'-article, 'topic-article'-article or a 'learningpath'
      */
     contextType?: string;
+    /**
+     * The publicId of the node connected via content-uri
+     */
+    id: string;
     /**
      * Whether the parent connection is marked as active
      */
@@ -522,6 +510,10 @@ export interface TaxonomyContext {
      * List of all parent ids
      */
     parentIds: string[];
+    /**
+     * List of all parents to this context
+     */
+    parents: TaxonomyCrumb[];
     /**
      * The context path
      */
@@ -559,6 +551,28 @@ export interface TaxonomyContext {
      */
     url?: string;
 }
+export interface TaxonomyCrumb {
+    /**
+     * Unique id of context based on root + parent connection
+     */
+    contextId: string;
+    /**
+     * The publicId of the node
+     */
+    id: string;
+    /**
+     * The name of the node
+     */
+    name: Record<string, string>;
+    /**
+     * The context path
+     */
+    path: string;
+    /**
+     * The context url
+     */
+    url: string;
+}
 export interface TopicPostPut {
     /**
      * ID of article introducing this topic. Must be a valid URI, but preferably not a URL.

package/package.json

@@ -17,5 +17,5 @@
   "devDependencies": {
     "typescript": "^5.0.2"
   },
-  "version": "1.0.27"
+  "version": "1.0.29"
 }

package/taxonomy-api.ts

@@ -32,9 +32,6 @@ export interface Node {
     baseName: string;
     breadcrumbs: string[];
     contentUri?: string;
-    /**
-     * The context object selected when fetching node
-     */
     context?: TaxonomyContext;
     /**
      * An id unique for this context.
@@ -307,23 +304,9 @@ export interface Relevance {
      * List of language codes supported by translations
      */
     supportedLanguages: string[];
-    /**
-     * All translations of this relevance
-     */
     translations: Translation[];
 }
 
-export interface RelevancePUT {
-    /**
-     * If specified, set the id to this value. Must start with urn:relevance: and be a valid URI. If ommitted, an id will be assigned automatically. Ignored on update
-     */
-    id: string;
-    /**
-     * The name of the relevance
-     */
-    name: string;
-}
-
 export interface ResolvedOldUrl {
     /**
      * URL path for resource
@@ -536,6 +519,10 @@ export interface TaxonomyContext {
      * Whether a 'standard'-article, 'topic-article'-article or a 'learningpath'
      */
     contextType?: string;
+    /**
+     * The publicId of the node connected via content-uri
+     */
+    id: string;
     /**
      * Whether the parent connection is marked as active
      */
@@ -556,6 +543,10 @@ export interface TaxonomyContext {
      * List of all parent ids
      */
     parentIds: string[];
+    /**
+     * List of all parents to this context
+     */
+    parents: TaxonomyCrumb[];
     /**
      * The context path
      */
@@ -594,6 +585,29 @@ export interface TaxonomyContext {
     url?: string;
 }
 
+export interface TaxonomyCrumb {
+    /**
+     * Unique id of context based on root + parent connection
+     */
+    contextId: string;
+    /**
+     * The publicId of the node
+     */
+    id: string;
+    /**
+     * The name of the node
+     */
+    name: Record<string, string>;
+    /**
+     * The context path
+     */
+    path: string;
+    /**
+     * The context url
+     */
+    url: string;
+}
+
 export interface TopicPostPut {
     /**
      * ID of article introducing this topic. Must be a valid URI, but preferably not a URL.