@ndla/types-taxonomy 1.0.34 → 1.0.36

package/build/taxonomy-api.d.ts

@@ -71,6 +71,10 @@ export interface NodeConnection {
      * Child id
      */
     childId: string;
+    /**
+     * Connection type
+     */
+    connectionType: NodeConnectionType;
     /**
      * Connection id
      */
@@ -101,6 +105,10 @@ export interface NodeConnectionPOST {
      * Child id
      */
     childId: string;
+    /**
+     * Connection type
+     */
+    connectionType?: NodeConnectionType;
     parentId: string;
     /**
      * If this connection is primary.
@@ -141,7 +149,7 @@ export interface NodePostPut {
     /**
      * The language used at create time. Used to set default translation.
      */
-    language?: string;
+    language: string;
     /**
      * The name of the node. Required on create.
      */
@@ -248,11 +256,11 @@ export interface NodeSearchBody {
     /**
      * Include all contexts
      */
-    includeContexts?: boolean;
+    includeContexts: boolean;
     /**
      * ISO-639-1 language code
      */
-    language?: string;
+    language: string;
     /**
      * Filter by nodeType
      */
@@ -308,6 +316,7 @@ export interface ResolvedOldUrl {
 }
 export interface ResolvedUrl {
     contentUri: string;
+    exactMatch: boolean;
     id: string;
     name: string;
     parents: string[];
@@ -405,6 +414,7 @@ export interface SearchResult<T> {
 export interface SearchableTaxonomyResourceType {
     id: string;
     name: Record<string, string>;
+    parentId?: string;
 }
 export interface SubjectPostPut {
     /**
@@ -524,7 +534,7 @@ export interface TaxonomyContext {
      */
     parentIds: string[];
     /**
-     * List of all parents to this context
+     * List of all parents to this context. Empty if node is fetched as child
      */
     parents: TaxonomyCrumb[];
     /**
@@ -769,7 +779,7 @@ export interface Version {
 }
 export interface VersionPostPut {
     /**
-     * If specified, set the id to this value. Must start with urn:subject: and be a valid URI. If omitted, an id will be assigned automatically.
+     * If specified, set the id to this value. Must start with urn:version: and be a valid URI. If ommitted, an id will be assigned automatically.
      */
     id?: string;
     /**
@@ -783,5 +793,6 @@ export interface VersionPostPut {
 }
 export type DateAsString = string;
 export type Grade = 1 | 2 | 3 | 4 | 5;
+export type NodeConnectionType = "BRANCH" | "LINK";
 export type NodeType = "NODE" | "SUBJECT" | "TOPIC" | "RESOURCE" | "PROGRAMME";
 export type VersionType = "BETA" | "PUBLISHED" | "ARCHIVED";

package/package.json

@@ -17,5 +17,5 @@
   "devDependencies": {
     "typescript": "^5.0.2"
   },
-  "version": "1.0.34"
+  "version": "1.0.36"
 }

package/taxonomy-api.ts

@@ -79,6 +79,10 @@ export interface NodeConnection {
      * Child id
      */
     childId: string;
+    /**
+     * Connection type
+     */
+    connectionType: NodeConnectionType;
     /**
      * Connection id
      */
@@ -110,6 +114,10 @@ export interface NodeConnectionPOST {
      * Child id
      */
     childId: string;
+    /**
+     * Connection type
+     */
+    connectionType?: NodeConnectionType;
     parentId: string;
     /**
      * If this connection is primary.
@@ -152,7 +160,7 @@ export interface NodePostPut {
     /**
      * The language used at create time. Used to set default translation.
      */
-    language?: string;
+    language: string;
     /**
      * The name of the node. Required on create.
      */
@@ -263,11 +271,11 @@ export interface NodeSearchBody {
     /**
      * Include all contexts
      */
-    includeContexts?: boolean;
+    includeContexts: boolean;
     /**
      * ISO-639-1 language code
      */
-    language?: string;
+    language: string;
     /**
      * Filter by nodeType
      */
@@ -328,6 +336,7 @@ export interface ResolvedOldUrl {
 
 export interface ResolvedUrl {
     contentUri: string;
+    exactMatch: boolean;
     id: string;
     name: string;
     parents: string[];
@@ -433,6 +442,7 @@ export interface SearchResult<T> {
 export interface SearchableTaxonomyResourceType {
     id: string;
     name: Record<string, string>;
+    parentId?: string;
 }
 
 export interface SubjectPostPut {
@@ -557,7 +567,7 @@ export interface TaxonomyContext {
      */
     parentIds: string[];
     /**
-     * List of all parents to this context
+     * List of all parents to this context. Empty if node is fetched as child
      */
     parents: TaxonomyCrumb[];
     /**
@@ -815,7 +825,7 @@ export interface Version {
 
 export interface VersionPostPut {
     /**
-     * If specified, set the id to this value. Must start with urn:subject: and be a valid URI. If omitted, an id will be assigned automatically.
+     * If specified, set the id to this value. Must start with urn:version: and be a valid URI. If ommitted, an id will be assigned automatically.
      */
     id?: string;
     /**
@@ -832,6 +842,8 @@ export type DateAsString = string;
 
 export type Grade = 1 | 2 | 3 | 4 | 5;
 
+export type NodeConnectionType = "BRANCH" | "LINK";
+
 export type NodeType = "NODE" | "SUBJECT" | "TOPIC" | "RESOURCE" | "PROGRAMME";
 
 export type VersionType = "BETA" | "PUBLISHED" | "ARCHIVED";