@ndla/types-taxonomy 1.0.28 → 1.0.30

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -26,9 +26,6 @@ export interface Node {
26
26
  baseName: string;
27
27
  breadcrumbs: string[];
28
28
  contentUri?: string;
29
- /**
30
- * The context object selected when fetching node
31
- */
32
29
  context?: TaxonomyContext;
33
30
  /**
34
31
  * An id unique for this context.
@@ -47,7 +44,7 @@ export interface Node {
47
44
  * The type of node
48
45
  */
49
46
  nodeType: NodeType;
50
- path: string;
47
+ path?: string;
51
48
  paths: string[];
52
49
  /**
53
50
  * Quality evaluation of the article
@@ -489,6 +486,10 @@ export interface TaxonomyContext {
489
486
  * Whether a 'standard'-article, 'topic-article'-article or a 'learningpath'
490
487
  */
491
488
  contextType?: string;
489
+ /**
490
+ * The publicId of the node connected via content-uri
491
+ */
492
+ id: string;
492
493
  /**
493
494
  * Whether the parent connection is marked as active
494
495
  */
@@ -509,6 +510,10 @@ export interface TaxonomyContext {
509
510
  * List of all parent ids
510
511
  */
511
512
  parentIds: string[];
513
+ /**
514
+ * List of all parents to this context
515
+ */
516
+ parents: TaxonomyCrumb[];
512
517
  /**
513
518
  * The context path
514
519
  */
@@ -544,7 +549,29 @@ export interface TaxonomyContext {
544
549
  /**
545
550
  * Pretty-url of this particular context
546
551
  */
547
- url?: string;
552
+ url: string;
553
+ }
554
+ export interface TaxonomyCrumb {
555
+ /**
556
+ * Unique id of context based on root + parent connection
557
+ */
558
+ contextId: string;
559
+ /**
560
+ * The publicId of the node
561
+ */
562
+ id: string;
563
+ /**
564
+ * The name of the node
565
+ */
566
+ name: Record<string, string>;
567
+ /**
568
+ * The context path
569
+ */
570
+ path: string;
571
+ /**
572
+ * The context url
573
+ */
574
+ url: string;
548
575
  }
549
576
  export interface TopicPostPut {
550
577
  /**
package/package.json CHANGED
@@ -17,5 +17,5 @@
17
17
  "devDependencies": {
18
18
  "typescript": "^5.0.2"
19
19
  },
20
- "version": "1.0.28"
20
+ "version": "1.0.30"
21
21
  }
package/taxonomy-api.ts CHANGED
@@ -32,9 +32,6 @@ export interface Node {
32
32
  baseName: string;
33
33
  breadcrumbs: string[];
34
34
  contentUri?: string;
35
- /**
36
- * The context object selected when fetching node
37
- */
38
35
  context?: TaxonomyContext;
39
36
  /**
40
37
  * An id unique for this context.
@@ -53,7 +50,7 @@ export interface Node {
53
50
  * The type of node
54
51
  */
55
52
  nodeType: NodeType;
56
- path: string;
53
+ path?: string;
57
54
  paths: string[];
58
55
  /**
59
56
  * Quality evaluation of the article
@@ -522,6 +519,10 @@ export interface TaxonomyContext {
522
519
  * Whether a 'standard'-article, 'topic-article'-article or a 'learningpath'
523
520
  */
524
521
  contextType?: string;
522
+ /**
523
+ * The publicId of the node connected via content-uri
524
+ */
525
+ id: string;
525
526
  /**
526
527
  * Whether the parent connection is marked as active
527
528
  */
@@ -542,6 +543,10 @@ export interface TaxonomyContext {
542
543
  * List of all parent ids
543
544
  */
544
545
  parentIds: string[];
546
+ /**
547
+ * List of all parents to this context
548
+ */
549
+ parents: TaxonomyCrumb[];
545
550
  /**
546
551
  * The context path
547
552
  */
@@ -577,7 +582,30 @@ export interface TaxonomyContext {
577
582
  /**
578
583
  * Pretty-url of this particular context
579
584
  */
580
- url?: string;
585
+ url: string;
586
+ }
587
+
588
+ export interface TaxonomyCrumb {
589
+ /**
590
+ * Unique id of context based on root + parent connection
591
+ */
592
+ contextId: string;
593
+ /**
594
+ * The publicId of the node
595
+ */
596
+ id: string;
597
+ /**
598
+ * The name of the node
599
+ */
600
+ name: Record<string, string>;
601
+ /**
602
+ * The context path
603
+ */
604
+ path: string;
605
+ /**
606
+ * The context url
607
+ */
608
+ url: string;
581
609
  }
582
610
 
583
611
  export interface TopicPostPut {