@ndla/types-taxonomy 1.0.7 → 1.0.8

package/README.md

@@ -0,0 +1,9 @@
+# NDLA taxonomy-api types
+
+TypeScript definitions for the NDLA taxonomy-api
+
+## Installation
+
+```sh
+yarn add -D @ndla/types-taxonomy
+```

package/build/taxonomy-api.d.ts

@@ -1,27 +1,27 @@
 export interface NodePostPut {
     nodeId?: string;
     /**
-     * Type of node. Values are subject, topic. Required on create.
+     * Type of node.
      */
     nodeType: NodeType;
     /**
      * ID of content introducing this node. Must be a valid URI, but preferably not a URL.
      */
-    contentUri: string;
+    contentUri?: string;
     /**
      * The name of the node. Required on create.
      */
-    name: string;
+    name?: string;
     /**
      * The node is a root node. Default is false. Only used if present.
      */
-    root: boolean;
+    root?: boolean;
 }
 export interface ResourcePostPut {
     /**
      * If specified, set the id to this value. Must start with urn:resource: and be a valid URI. If omitted, an id will be assigned automatically.
      */
-    id: string;
+    id?: string;
     /**
      * The ID of this resource in the system where the content is stored. This ID should be of the form 'urn:<system>:<id>', where <system> is a short identifier for the system, and <id> is the id of this content in that system.
      */
@@ -37,9 +37,9 @@ export interface SubjectPostPut {
      */
     id: string;
     /**
-     * ID of article introducing this subject. Must be a valid URI, but preferably not a URL.
+     * ID of frontpage connected to this subject. Must be a valid URI, but preferably not a URL.
      */
-    contentUri: string;
+    contentUri?: string;
     /**
      * The name of the subject
      */
@@ -71,7 +71,7 @@ export interface VersionPostPut {
     /**
      * If specified, set the locked property to this value.
      */
-    locked: boolean;
+    locked?: boolean;
 }
 export interface Context {
     id: string;
@@ -95,7 +95,7 @@ export interface NodeConnection {
      */
     id: string;
     /**
-     * Backwards compatibility: Always true. Ignored on insert/update
+     * Is this connection primary
      */
     primary: boolean;
     /**
@@ -105,7 +105,7 @@ export interface NodeConnection {
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
     /**
      * Metadata for entity. Read only.
      */
@@ -118,35 +118,31 @@ export interface NodeConnectionPOST {
      */
     childId: string;
     /**
-     * Backwards compatibility: Always true. Ignored on insert/update
+     * If this connection is primary.
      */
-    primary: boolean;
+    primary?: boolean;
     /**
      * Order in which to sort the child for the parent
      */
-    rank: number;
+    rank?: number;
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
 }
 export interface NodeConnectionPUT {
     /**
-     * Connection id
+     * If this connection is primary.
      */
-    id: string;
-    /**
-     * Backwards compatibility: Always true. Ignored on insert/update
-     */
-    primary: boolean;
+    primary?: boolean;
     /**
      * Order in which subtopic is sorted for the topic
      */
-    rank: number;
+    rank?: number;
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
 }
 export interface NodeResource {
     /**
@@ -172,7 +168,7 @@ export interface NodeResource {
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
     /**
      * Metadata for entity. Read only.
      */
@@ -190,15 +186,15 @@ export interface NodeResourcePOST {
     /**
      * Primary connection
      */
-    primary: boolean;
+    primary?: boolean;
     /**
      * Order in which resource is sorted for the node
      */
-    rank: number;
+    rank?: number;
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
 }
 export interface NodeResourcePUT {
     /**
@@ -208,15 +204,15 @@ export interface NodeResourcePUT {
     /**
      * Primary connection
      */
-    primary: boolean;
+    primary?: boolean;
     /**
      * Order in which the resource will be sorted for this node.
      */
-    rank: number;
+    rank?: number;
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
 }
 export interface Relevance {
     /**
@@ -333,7 +329,7 @@ export interface SubjectTopic {
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
 }
 export interface SubjectTopicPOST {
     /**
@@ -347,33 +343,29 @@ export interface SubjectTopicPOST {
     /**
      * Backwards compatibility: Always true, ignored on insert/update.
      */
-    primary: boolean;
+    primary?: boolean;
     /**
      * Order in which the topic should be sorted for the topic
      */
-    rank: number;
+    rank?: number;
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
 }
 export interface SubjectTopicPUT {
-    /**
-     * connection id
-     */
-    id: string;
     /**
      * If true, set this subject as the primary subject for this topic. This will replace any other primary subject for this topic. You must have one primary subject, so it is not allowed to set the currently primary subject to not be primary any more.
      */
-    primary: boolean;
+    primary?: boolean;
     /**
      * Order in which the topic should be sorted for the subject
      */
-    rank: number;
+    rank?: number;
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
 }
 export interface TopicResource {
     /**
@@ -399,7 +391,7 @@ export interface TopicResource {
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
 }
 export interface TopicResourcePOST {
     /**
@@ -413,33 +405,29 @@ export interface TopicResourcePOST {
     /**
      * Primary connection
      */
-    primary: boolean;
+    primary?: boolean;
     /**
      * Order in which resource is sorted for the topic
      */
-    rank: number;
+    rank?: number;
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
 }
 export interface TopicResourcePUT {
-    /**
-     * Topic resource connection id
-     */
-    id: string;
     /**
      * Primary connection
      */
-    primary: boolean;
+    primary?: boolean;
     /**
      * Order in which the resource will be sorted for this topic.
      */
-    rank: number;
+    rank?: number;
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
 }
 export interface TopicSubtopic {
     /**
@@ -465,7 +453,7 @@ export interface TopicSubtopic {
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
 }
 export interface TopicSubtopicPOST {
     /**
@@ -477,35 +465,31 @@ export interface TopicSubtopicPOST {
      */
     subtopicid: string;
     /**
-     * Backwards compatibility: Always true. Ignored on insert/update
+     * Is this connection primary
      */
-    primary: boolean;
+    primary?: boolean;
     /**
      * Order in which to sort the subtopic for the topic
      */
-    rank: number;
+    rank?: number;
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
 }
 export interface TopicSubtopicPUT {
     /**
-     * Connection id
-     */
-    id: string;
-    /**
-     * Backwards compatibility: Always true. Ignored on insert/update
+     * Is this connection primary
      */
-    primary: boolean;
+    primary?: boolean;
     /**
      * Order in which subtopic is sorted for the topic
      */
-    rank: number;
+    rank?: number;
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
 }
 export interface TranslationPUT {
     /**
@@ -590,8 +574,8 @@ export interface TaxonomyContext {
     contextId: string;
     id: string;
     subject: Record<string, string>;
-    parentTopicIds: string[];
     subjectId: string;
+    parentTopicIds: string[];
     isPrimaryConnection: boolean;
 }
 export interface Connection {
@@ -620,7 +604,7 @@ export interface Node {
     path: string;
     paths: string[];
     metadata: Metadata;
-    relevanceId: string;
+    relevanceId?: string;
     translations: Translation[];
     supportedLanguages: string[];
     breadcrumbs: string[];

package/package.json

@@ -17,5 +17,5 @@
   "devDependencies": {
     "typescript": "^5.0.2"
   },
-  "version": "1.0.7"
+  "version": "1.0.8"
 }

package/taxonomy-api.ts

@@ -2,28 +2,28 @@
 export interface NodePostPut {
     nodeId?: string;
     /**
-     * Type of node. Values are subject, topic. Required on create.
+     * Type of node.
      */
     nodeType: NodeType;
     /**
      * ID of content introducing this node. Must be a valid URI, but preferably not a URL.
      */
-    contentUri: string;
+    contentUri?: string;
     /**
      * The name of the node. Required on create.
      */
-    name: string;
+    name?: string;
     /**
      * The node is a root node. Default is false. Only used if present.
      */
-    root: boolean;
+    root?: boolean;
 }
 
 export interface ResourcePostPut {
     /**
      * If specified, set the id to this value. Must start with urn:resource: and be a valid URI. If omitted, an id will be assigned automatically.
      */
-    id: string;
+    id?: string;
     /**
      * The ID of this resource in the system where the content is stored. This ID should be of the form 'urn:<system>:<id>', where <system> is a short identifier for the system, and <id> is the id of this content in that system.
      */
@@ -40,9 +40,9 @@ export interface SubjectPostPut {
      */
     id: string;
     /**
-     * ID of article introducing this subject. Must be a valid URI, but preferably not a URL.
+     * ID of frontpage connected to this subject. Must be a valid URI, but preferably not a URL.
      */
-    contentUri: string;
+    contentUri?: string;
     /**
      * The name of the subject
      */
@@ -76,7 +76,7 @@ export interface VersionPostPut {
     /**
      * If specified, set the locked property to this value.
      */
-    locked: boolean;
+    locked?: boolean;
 }
 
 export interface Context {
@@ -103,7 +103,7 @@ export interface NodeConnection {
      */
     id: string;
     /**
-     * Backwards compatibility: Always true. Ignored on insert/update
+     * Is this connection primary
      */
     primary: boolean;
     /**
@@ -113,7 +113,7 @@ export interface NodeConnection {
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
     /**
      * Metadata for entity. Read only.
      */
@@ -127,36 +127,32 @@ export interface NodeConnectionPOST {
      */
     childId: string;
     /**
-     * Backwards compatibility: Always true. Ignored on insert/update
+     * If this connection is primary.
      */
-    primary: boolean;
+    primary?: boolean;
     /**
      * Order in which to sort the child for the parent
      */
-    rank: number;
+    rank?: number;
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
 }
 
 export interface NodeConnectionPUT {
     /**
-     * Connection id
+     * If this connection is primary.
      */
-    id: string;
-    /**
-     * Backwards compatibility: Always true. Ignored on insert/update
-     */
-    primary: boolean;
+    primary?: boolean;
     /**
      * Order in which subtopic is sorted for the topic
      */
-    rank: number;
+    rank?: number;
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
 }
 
 export interface NodeResource {
@@ -183,7 +179,7 @@ export interface NodeResource {
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
     /**
      * Metadata for entity. Read only.
      */
@@ -202,15 +198,15 @@ export interface NodeResourcePOST {
     /**
      * Primary connection
      */
-    primary: boolean;
+    primary?: boolean;
     /**
      * Order in which resource is sorted for the node
      */
-    rank: number;
+    rank?: number;
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
 }
 
 export interface NodeResourcePUT {
@@ -221,15 +217,15 @@ export interface NodeResourcePUT {
     /**
      * Primary connection
      */
-    primary: boolean;
+    primary?: boolean;
     /**
      * Order in which the resource will be sorted for this node.
      */
-    rank: number;
+    rank?: number;
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
 }
 
 export interface Relevance {
@@ -354,7 +350,7 @@ export interface SubjectTopic {
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
 }
 
 export interface SubjectTopicPOST {
@@ -369,34 +365,30 @@ export interface SubjectTopicPOST {
     /**
      * Backwards compatibility: Always true, ignored on insert/update.
      */
-    primary: boolean;
+    primary?: boolean;
     /**
      * Order in which the topic should be sorted for the topic
      */
-    rank: number;
+    rank?: number;
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
 }
 
 export interface SubjectTopicPUT {
-    /**
-     * connection id
-     */
-    id: string;
     /**
      * If true, set this subject as the primary subject for this topic. This will replace any other primary subject for this topic. You must have one primary subject, so it is not allowed to set the currently primary subject to not be primary any more.
      */
-    primary: boolean;
+    primary?: boolean;
     /**
      * Order in which the topic should be sorted for the subject
      */
-    rank: number;
+    rank?: number;
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
 }
 
 export interface TopicResource {
@@ -423,7 +415,7 @@ export interface TopicResource {
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
 }
 
 export interface TopicResourcePOST {
@@ -438,34 +430,30 @@ export interface TopicResourcePOST {
     /**
      * Primary connection
      */
-    primary: boolean;
+    primary?: boolean;
     /**
      * Order in which resource is sorted for the topic
      */
-    rank: number;
+    rank?: number;
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
 }
 
 export interface TopicResourcePUT {
-    /**
-     * Topic resource connection id
-     */
-    id: string;
     /**
      * Primary connection
      */
-    primary: boolean;
+    primary?: boolean;
     /**
      * Order in which the resource will be sorted for this topic.
      */
-    rank: number;
+    rank?: number;
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
 }
 
 export interface TopicSubtopic {
@@ -492,7 +480,7 @@ export interface TopicSubtopic {
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
 }
 
 export interface TopicSubtopicPOST {
@@ -505,36 +493,32 @@ export interface TopicSubtopicPOST {
      */
     subtopicid: string;
     /**
-     * Backwards compatibility: Always true. Ignored on insert/update
+     * Is this connection primary
      */
-    primary: boolean;
+    primary?: boolean;
     /**
      * Order in which to sort the subtopic for the topic
      */
-    rank: number;
+    rank?: number;
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
 }
 
 export interface TopicSubtopicPUT {
     /**
-     * Connection id
-     */
-    id: string;
-    /**
-     * Backwards compatibility: Always true. Ignored on insert/update
+     * Is this connection primary
      */
-    primary: boolean;
+    primary?: boolean;
     /**
      * Order in which subtopic is sorted for the topic
      */
-    rank: number;
+    rank?: number;
     /**
      * Relevance id
      */
-    relevanceId: string;
+    relevanceId?: string;
 }
 
 export interface TranslationPUT {
@@ -623,8 +607,8 @@ export interface TaxonomyContext {
     contextId: string;
     id: string;
     subject: Record<string, string>;
-    parentTopicIds: string[];
     subjectId: string;
+    parentTopicIds: string[];
     isPrimaryConnection: boolean;
 }
 
@@ -657,7 +641,7 @@ export interface Node {
     path: string;
     paths: string[];
     metadata: Metadata;
-    relevanceId: string;
+    relevanceId?: string;
     translations: Translation[];
     supportedLanguages: string[];
     breadcrumbs: string[];