@ndla/types-taxonomy 1.0.12 → 1.0.13

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.
@@ -44,6 +44,9 @@ export interface Node {
44
44
  export interface NodeChild extends Node {
45
45
  connectionId: string;
46
46
  isPrimary: boolean;
47
+ /**
48
+ * @deprecated
49
+ */
47
50
  parent: string;
48
51
  parentId: string;
49
52
  rank: number;
@@ -315,7 +318,7 @@ export interface ResourceTypeWithConnection {
315
318
  connectionId: string;
316
319
  id: string;
317
320
  name: string;
318
- parentId: string;
321
+ parentId?: string;
319
322
  /**
320
323
  * List of language codes supported by translations
321
324
  */
@@ -421,7 +424,10 @@ export interface TaxonomyContext {
421
424
  * Whether a 'standard'-article, 'topic-article'-article or a 'learningpath'
422
425
  */
423
426
  contextType?: string;
424
- id: string;
427
+ /**
428
+ * @deprecated
429
+ */
430
+ id?: string;
425
431
  /**
426
432
  * Whether the base connection is marked as active subject
427
433
  */
@@ -430,7 +436,10 @@ export interface TaxonomyContext {
430
436
  * Whether the base connection is primary or not
431
437
  */
432
438
  isPrimary: boolean;
433
- isPrimaryConnection: boolean;
439
+ /**
440
+ * @deprecated
441
+ */
442
+ isPrimaryConnection?: boolean;
434
443
  /**
435
444
  * Whether the base connection is visible or not
436
445
  */
@@ -439,7 +448,10 @@ export interface TaxonomyContext {
439
448
  * List of all parent topic-ids
440
449
  */
441
450
  parentIds: string[];
442
- parentTopicIds: string[];
451
+ /**
452
+ * @deprecated
453
+ */
454
+ parentTopicIds?: string[];
443
455
  /**
444
456
  * The context path
445
457
  */
@@ -455,7 +467,7 @@ export interface TaxonomyContext {
455
467
  /**
456
468
  * Id of the relevance of the connection of the base
457
469
  */
458
- relevanceId: string;
470
+ relevanceId?: string;
459
471
  /**
460
472
  * Resource-types of the base
461
473
  */
@@ -468,8 +480,14 @@ export interface TaxonomyContext {
468
480
  * The publicId of the root parent of the context
469
481
  */
470
482
  rootId: string;
471
- subject: Record<string, string>;
472
- subjectId: string;
483
+ /**
484
+ * @deprecated
485
+ */
486
+ subject?: Record<string, string>;
487
+ /**
488
+ * @deprecated
489
+ */
490
+ subjectId?: string;
473
491
  }
474
492
  export interface TopicPostPut {
475
493
  /**
package/package.json CHANGED
@@ -17,5 +17,5 @@
17
17
  "devDependencies": {
18
18
  "typescript": "^5.0.2"
19
19
  },
20
- "version": "1.0.12"
20
+ "version": "1.0.13"
21
21
  }
package/taxonomy-api.ts CHANGED
@@ -50,6 +50,9 @@ export interface Node {
50
50
  export interface NodeChild extends Node {
51
51
  connectionId: string;
52
52
  isPrimary: boolean;
53
+ /**
54
+ * @deprecated
55
+ */
53
56
  parent: string;
54
57
  parentId: string;
55
58
  rank: number;
@@ -339,7 +342,7 @@ export interface ResourceTypeWithConnection {
339
342
  connectionId: string;
340
343
  id: string;
341
344
  name: string;
342
- parentId: string;
345
+ parentId?: string;
343
346
  /**
344
347
  * List of language codes supported by translations
345
348
  */
@@ -452,7 +455,10 @@ export interface TaxonomyContext {
452
455
  * Whether a 'standard'-article, 'topic-article'-article or a 'learningpath'
453
456
  */
454
457
  contextType?: string;
455
- id: string;
458
+ /**
459
+ * @deprecated
460
+ */
461
+ id?: string;
456
462
  /**
457
463
  * Whether the base connection is marked as active subject
458
464
  */
@@ -461,7 +467,10 @@ export interface TaxonomyContext {
461
467
  * Whether the base connection is primary or not
462
468
  */
463
469
  isPrimary: boolean;
464
- isPrimaryConnection: boolean;
470
+ /**
471
+ * @deprecated
472
+ */
473
+ isPrimaryConnection?: boolean;
465
474
  /**
466
475
  * Whether the base connection is visible or not
467
476
  */
@@ -470,7 +479,10 @@ export interface TaxonomyContext {
470
479
  * List of all parent topic-ids
471
480
  */
472
481
  parentIds: string[];
473
- parentTopicIds: string[];
482
+ /**
483
+ * @deprecated
484
+ */
485
+ parentTopicIds?: string[];
474
486
  /**
475
487
  * The context path
476
488
  */
@@ -486,7 +498,7 @@ export interface TaxonomyContext {
486
498
  /**
487
499
  * Id of the relevance of the connection of the base
488
500
  */
489
- relevanceId: string;
501
+ relevanceId?: string;
490
502
  /**
491
503
  * Resource-types of the base
492
504
  */
@@ -499,8 +511,14 @@ export interface TaxonomyContext {
499
511
  * The publicId of the root parent of the context
500
512
  */
501
513
  rootId: string;
502
- subject: Record<string, string>;
503
- subjectId: string;
514
+ /**
515
+ * @deprecated
516
+ */
517
+ subject?: Record<string, string>;
518
+ /**
519
+ * @deprecated
520
+ */
521
+ subjectId?: string;
504
522
  }
505
523
 
506
524
  export interface TopicPostPut {