@ndla/types-taxonomy 1.0.1

package/build/taxonomy-api.d.ts

@@ -0,0 +1,616 @@
+export interface Context {
+    id: string;
+    path: string;
+    name: string;
+}
+export interface ContextPOST {
+    id: string;
+}
+export interface NodeConnection {
+    /**
+     * Parent id
+     */
+    parentId: string;
+    /**
+     * Child id
+     */
+    childId: string;
+    /**
+     * Connection id
+     */
+    id: string;
+    /**
+     * Backwards compatibility: Always true. Ignored on insert/update
+     */
+    primary: boolean;
+    /**
+     * Order in which subtopic is sorted for the topic
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+    /**
+     * Metadata for entity. Read only.
+     */
+    metadata: Metadata;
+}
+export interface NodeConnectionPOST {
+    parentId: string;
+    /**
+     * Child id
+     */
+    childId: string;
+    /**
+     * Backwards compatibility: Always true. Ignored on insert/update
+     */
+    primary: boolean;
+    /**
+     * Order in which to sort the child for the parent
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+}
+export interface NodeConnectionPUT {
+    /**
+     * Connection id
+     */
+    id: string;
+    /**
+     * Backwards compatibility: Always true. Ignored on insert/update
+     */
+    primary: boolean;
+    /**
+     * Order in which subtopic is sorted for the topic
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+}
+export interface NodeResource {
+    /**
+     * Node id
+     */
+    nodeId: string;
+    /**
+     * Resource id
+     */
+    resourceId: string;
+    /**
+     * Node resource connection id
+     */
+    id: string;
+    /**
+     * Primary connection
+     */
+    primary: boolean;
+    /**
+     * Order in which the resource is sorted for the node
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+    /**
+     * Metadata for entity. Read only.
+     */
+    metadata: Metadata;
+}
+export interface NodeResourcePOST {
+    /**
+     * Node id
+     */
+    nodeId: string;
+    /**
+     * Resource id
+     */
+    resourceId: string;
+    /**
+     * Primary connection
+     */
+    primary: boolean;
+    /**
+     * Order in which resource is sorted for the node
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+}
+export interface NodeResourcePUT {
+    /**
+     * Node resource connection id
+     */
+    id: string;
+    /**
+     * Primary connection
+     */
+    primary: boolean;
+    /**
+     * Order in which the resource will be sorted for this node.
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+}
+export interface Relevance {
+    /**
+     * Specifies if node is core or supplementary
+     */
+    id: string;
+    /**
+     * The name of the relevance
+     */
+    name: string;
+    /**
+     * All translations of this relevance
+     */
+    translations: Translation[];
+    /**
+     * List of language codes supported by translations
+     */
+    supportedLanguages: string[];
+}
+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
+     */
+    path: string;
+}
+export interface ResourceResourceType {
+    /**
+     * Resource type id
+     */
+    resourceId: string;
+    /**
+     * Resource type id
+     */
+    resourceTypeId: string;
+    /**
+     * Resource to resource type connection id
+     */
+    id: string;
+}
+export interface ResourceResourceTypePOST {
+    /**
+     * Resource id
+     */
+    resourceId: string;
+    /**
+     * Resource type id
+     */
+    resourceTypeId: string;
+}
+export interface ResourceType {
+    id: string;
+    /**
+     * The name of the resource type
+     */
+    name: string;
+    /**
+     * Sub resource types
+     */
+    subtypes: ResourceType[];
+    /**
+     * All translations of this resource type
+     */
+    translations: Translation[];
+    /**
+     * List of language codes supported by translations
+     */
+    supportedLanguages: string[];
+}
+export interface ResourceTypePUT {
+    /**
+     * If specified, the new resource type will be a child of the mentioned resource type.
+     */
+    parentId: string;
+    /**
+     * If specified, set the id to this value. Must start with urn:resourcetype: and be a valid URI. If omitted, an id will be assigned automatically.
+     */
+    id: string;
+    /**
+     * The name of the resource type
+     */
+    name: string;
+}
+export interface SubjectTopic {
+    /**
+     * Subject id
+     */
+    subjectid: string;
+    /**
+     * Topic id
+     */
+    topicid: string;
+    /**
+     * Connection id
+     */
+    id: string;
+    /**
+     * primary
+     */
+    primary: boolean;
+    /**
+     * Order in which the topic is sorted under the subject
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+}
+export interface SubjectTopicPOST {
+    /**
+     * Subject id
+     */
+    subjectid: string;
+    /**
+     * Topic id
+     */
+    topicid: string;
+    /**
+     * Backwards compatibility: Always true, ignored on insert/update.
+     */
+    primary: boolean;
+    /**
+     * Order in which the topic should be sorted for the topic
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    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;
+    /**
+     * Order in which the topic should be sorted for the subject
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+}
+export interface TopicResource {
+    /**
+     * Topic id
+     */
+    topicid: string;
+    /**
+     * Resource id
+     */
+    resourceId: string;
+    /**
+     * Topic resource connection id
+     */
+    id: string;
+    /**
+     * Primary connection
+     */
+    primary: boolean;
+    /**
+     * Order in which the resource is sorted for the topic
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+}
+export interface TopicResourcePOST {
+    /**
+     * Topic id
+     */
+    topicid: string;
+    /**
+     * Resource id
+     */
+    resourceId: string;
+    /**
+     * Primary connection
+     */
+    primary: boolean;
+    /**
+     * Order in which resource is sorted for the topic
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+}
+export interface TopicResourcePUT {
+    /**
+     * Topic resource connection id
+     */
+    id: string;
+    /**
+     * Primary connection
+     */
+    primary: boolean;
+    /**
+     * Order in which the resource will be sorted for this topic.
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+}
+export interface TopicSubtopic {
+    /**
+     * Topic id
+     */
+    topicid: string;
+    /**
+     * Subtopic id
+     */
+    subtopicid: string;
+    /**
+     * Connection id
+     */
+    id: string;
+    /**
+     * Backwards compatibility: Always true. Ignored on insert/update
+     */
+    primary: boolean;
+    /**
+     * Order in which subtopic is sorted for the topic
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+}
+export interface TopicSubtopicPOST {
+    /**
+     * Topic id
+     */
+    topicid: string;
+    /**
+     * Subtopic id
+     */
+    subtopicid: string;
+    /**
+     * Backwards compatibility: Always true. Ignored on insert/update
+     */
+    primary: boolean;
+    /**
+     * Order in which to sort the subtopic for the topic
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+}
+export interface TopicSubtopicPUT {
+    /**
+     * Connection id
+     */
+    id: string;
+    /**
+     * Backwards compatibility: Always true. Ignored on insert/update
+     */
+    primary: boolean;
+    /**
+     * Order in which subtopic is sorted for the topic
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+}
+export interface TranslationPUT {
+    /**
+     * The translated name of the element. Used wherever translated texts are used.
+     */
+    name: string;
+}
+export interface UrlMapping {
+    /**
+     * URL for resource in old system
+     */
+    url: string;
+    /**
+     * Node URN for resource in new system
+     */
+    nodeId: string;
+    /**
+     * Subject URN for resource in new system (optional)
+     */
+    subjectId: string;
+}
+export interface SearchableTaxonomyResourceType {
+    id: string;
+    name: Record<string, string>;
+}
+export interface TaxonomyContext {
+    /**
+     * The publicId of the node connected via content-uri
+     */
+    publicId: string;
+    /**
+     * The publicId of the root parent of the context
+     */
+    rootId: string;
+    /**
+     * The name of the root parent of the context
+     */
+    root: Record<string, string>;
+    /**
+     * The context path
+     */
+    path: string;
+    /**
+     * A breadcrumb of the names of the context's path
+     */
+    breadcrumbs: Record<string, string[]>;
+    /**
+     * Whether a 'standard'-article, 'topic-article'-article or a 'learningpath'
+     */
+    contextType?: string;
+    /**
+     * Id of the relevance of the connection of the base
+     */
+    relevanceId: string;
+    /**
+     * Name of the relevance of the connection of the base
+     */
+    relevance: Record<string, string>;
+    /**
+     * Resource-types of the base
+     */
+    resourceTypes: SearchableTaxonomyResourceType[];
+    /**
+     * List of all parent topic-ids
+     */
+    parentIds: string[];
+    /**
+     * Whether the base connection is primary or not
+     */
+    isPrimary: boolean;
+    /**
+     * Whether the base connection is visible or not
+     */
+    isVisible: boolean;
+    /**
+     * Unique id of context based on root + connection
+     */
+    contextId: string;
+    id: string;
+    subject: Record<string, string>;
+    subjectId: string;
+    parentTopicIds: string[];
+    isPrimaryConnection: boolean;
+}
+export interface Connection {
+    connectionId: string;
+    targetId: string;
+    paths: string[];
+    type: string;
+    /**
+     * True if owned by this topic, false if it has its primary connection elsewhere
+     */
+    isPrimary: boolean;
+    primary: boolean;
+}
+export interface Metadata {
+    grepCodes: string[];
+    visible: boolean;
+    customFields: Record<string, string>;
+}
+export interface NodeChild extends Node {
+    parentId: string;
+    connectionId: string;
+    rank: number;
+    parent: string;
+    primary: boolean;
+}
+export interface Node {
+    id: string;
+    name: string;
+    contentUri?: string;
+    path: string;
+    paths: string[];
+    metadata: Metadata;
+    relevanceId: string;
+    translations: Translation[];
+    supportedLanguages: string[];
+    breadcrumbs: string[];
+    resourceTypes: ResourceTypeWithConnection[];
+    /**
+     * The type of node
+     */
+    nodeType: NodeType;
+    /**
+     * An id unique for this context.
+     */
+    contextId?: string;
+    url?: string;
+    contexts: TaxonomyContext[];
+}
+export interface NodeWithParents extends Node {
+    parents: NodeChild[];
+}
+export interface ResolvedUrl {
+    id: string;
+    contentUri: string;
+    name: string;
+    parents: string[];
+    path: string;
+}
+export interface ResourceTypeWithConnection {
+    id: string;
+    parentId: string;
+    name: string;
+    translations: Translation[];
+    /**
+     * List of language codes supported by translations
+     */
+    supportedLanguages: string[];
+    connectionId: string;
+}
+export interface SearchResult<T> {
+    totalCount: number;
+    page: number;
+    pageSize: number;
+    results: T[];
+}
+export interface Translation {
+    /**
+     * The translated name of the node
+     */
+    name: string;
+    /**
+     * ISO 639-1 language code
+     */
+    language: string;
+}
+export interface Version {
+    id: string;
+    versionType: VersionType;
+    name: string;
+    hash: string;
+    /**
+     * Is the version locked
+     */
+    locked: boolean;
+    created: DateAsString;
+    published?: DateAsString;
+    archived?: DateAsString;
+}
+export type DateAsString = string;
+export type NodeType = "NODE" | "SUBJECT" | "TOPIC" | "RESOURCE";
+export type VersionType = "BETA" | "PUBLISHED" | "ARCHIVED";

package/build/taxonomy-api.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=taxonomy-api.js.map

package/build/taxonomy-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"taxonomy-api.js","sourceRoot":"","sources":["../taxonomy-api.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@ndla/types-taxonomy",
+  "description": "Typescript type definitions for NDLA taxonomy-api",
+  "license": "GPL-3.0",
+  "scripts": {
+    "build": "tsc",
+    "do-publish": "tsc"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/NDLANO/taxonomy-api.git",
+    "directory": "typescript"
+  },
+  "author": "ndla@knowit.no",
+  "types": "build/taxonomy-api.d.ts",
+  "main": "taxonomy-api.js",
+  "devDependencies": {
+    "typescript": "^5.0.2"
+  },
+  "version": "1.0.1"
+}

package/taxonomy-api.ts

@@ -0,0 +1,657 @@
+
+export interface Context {
+    id: string;
+    path: string;
+    name: string;
+}
+
+export interface ContextPOST {
+    id: string;
+}
+
+export interface NodeConnection {
+    /**
+     * Parent id
+     */
+    parentId: string;
+    /**
+     * Child id
+     */
+    childId: string;
+    /**
+     * Connection id
+     */
+    id: string;
+    /**
+     * Backwards compatibility: Always true. Ignored on insert/update
+     */
+    primary: boolean;
+    /**
+     * Order in which subtopic is sorted for the topic
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+    /**
+     * Metadata for entity. Read only.
+     */
+    metadata: Metadata;
+}
+
+export interface NodeConnectionPOST {
+    parentId: string;
+    /**
+     * Child id
+     */
+    childId: string;
+    /**
+     * Backwards compatibility: Always true. Ignored on insert/update
+     */
+    primary: boolean;
+    /**
+     * Order in which to sort the child for the parent
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+}
+
+export interface NodeConnectionPUT {
+    /**
+     * Connection id
+     */
+    id: string;
+    /**
+     * Backwards compatibility: Always true. Ignored on insert/update
+     */
+    primary: boolean;
+    /**
+     * Order in which subtopic is sorted for the topic
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+}
+
+export interface NodeResource {
+    /**
+     * Node id
+     */
+    nodeId: string;
+    /**
+     * Resource id
+     */
+    resourceId: string;
+    /**
+     * Node resource connection id
+     */
+    id: string;
+    /**
+     * Primary connection
+     */
+    primary: boolean;
+    /**
+     * Order in which the resource is sorted for the node
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+    /**
+     * Metadata for entity. Read only.
+     */
+    metadata: Metadata;
+}
+
+export interface NodeResourcePOST {
+    /**
+     * Node id
+     */
+    nodeId: string;
+    /**
+     * Resource id
+     */
+    resourceId: string;
+    /**
+     * Primary connection
+     */
+    primary: boolean;
+    /**
+     * Order in which resource is sorted for the node
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+}
+
+export interface NodeResourcePUT {
+    /**
+     * Node resource connection id
+     */
+    id: string;
+    /**
+     * Primary connection
+     */
+    primary: boolean;
+    /**
+     * Order in which the resource will be sorted for this node.
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+}
+
+export interface Relevance {
+    /**
+     * Specifies if node is core or supplementary
+     */
+    id: string;
+    /**
+     * The name of the relevance
+     */
+    name: string;
+    /**
+     * All translations of this relevance
+     */
+    translations: Translation[];
+    /**
+     * List of language codes supported by translations
+     */
+    supportedLanguages: string[];
+}
+
+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
+     */
+    path: string;
+}
+
+export interface ResourceResourceType {
+    /**
+     * Resource type id
+     */
+    resourceId: string;
+    /**
+     * Resource type id
+     */
+    resourceTypeId: string;
+    /**
+     * Resource to resource type connection id
+     */
+    id: string;
+}
+
+export interface ResourceResourceTypePOST {
+    /**
+     * Resource id
+     */
+    resourceId: string;
+    /**
+     * Resource type id
+     */
+    resourceTypeId: string;
+}
+
+export interface ResourceType {
+    id: string;
+    /**
+     * The name of the resource type
+     */
+    name: string;
+    /**
+     * Sub resource types
+     */
+    subtypes: ResourceType[];
+    /**
+     * All translations of this resource type
+     */
+    translations: Translation[];
+    /**
+     * List of language codes supported by translations
+     */
+    supportedLanguages: string[];
+}
+
+export interface ResourceTypePUT {
+    /**
+     * If specified, the new resource type will be a child of the mentioned resource type.
+     */
+    parentId: string;
+    /**
+     * If specified, set the id to this value. Must start with urn:resourcetype: and be a valid URI. If omitted, an id will be assigned automatically.
+     */
+    id: string;
+    /**
+     * The name of the resource type
+     */
+    name: string;
+}
+
+export interface SubjectTopic {
+    /**
+     * Subject id
+     */
+    subjectid: string;
+    /**
+     * Topic id
+     */
+    topicid: string;
+    /**
+     * Connection id
+     */
+    id: string;
+    /**
+     * primary
+     */
+    primary: boolean;
+    /**
+     * Order in which the topic is sorted under the subject
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+}
+
+export interface SubjectTopicPOST {
+    /**
+     * Subject id
+     */
+    subjectid: string;
+    /**
+     * Topic id
+     */
+    topicid: string;
+    /**
+     * Backwards compatibility: Always true, ignored on insert/update.
+     */
+    primary: boolean;
+    /**
+     * Order in which the topic should be sorted for the topic
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    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;
+    /**
+     * Order in which the topic should be sorted for the subject
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+}
+
+export interface TopicResource {
+    /**
+     * Topic id
+     */
+    topicid: string;
+    /**
+     * Resource id
+     */
+    resourceId: string;
+    /**
+     * Topic resource connection id
+     */
+    id: string;
+    /**
+     * Primary connection
+     */
+    primary: boolean;
+    /**
+     * Order in which the resource is sorted for the topic
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+}
+
+export interface TopicResourcePOST {
+    /**
+     * Topic id
+     */
+    topicid: string;
+    /**
+     * Resource id
+     */
+    resourceId: string;
+    /**
+     * Primary connection
+     */
+    primary: boolean;
+    /**
+     * Order in which resource is sorted for the topic
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+}
+
+export interface TopicResourcePUT {
+    /**
+     * Topic resource connection id
+     */
+    id: string;
+    /**
+     * Primary connection
+     */
+    primary: boolean;
+    /**
+     * Order in which the resource will be sorted for this topic.
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+}
+
+export interface TopicSubtopic {
+    /**
+     * Topic id
+     */
+    topicid: string;
+    /**
+     * Subtopic id
+     */
+    subtopicid: string;
+    /**
+     * Connection id
+     */
+    id: string;
+    /**
+     * Backwards compatibility: Always true. Ignored on insert/update
+     */
+    primary: boolean;
+    /**
+     * Order in which subtopic is sorted for the topic
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+}
+
+export interface TopicSubtopicPOST {
+    /**
+     * Topic id
+     */
+    topicid: string;
+    /**
+     * Subtopic id
+     */
+    subtopicid: string;
+    /**
+     * Backwards compatibility: Always true. Ignored on insert/update
+     */
+    primary: boolean;
+    /**
+     * Order in which to sort the subtopic for the topic
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+}
+
+export interface TopicSubtopicPUT {
+    /**
+     * Connection id
+     */
+    id: string;
+    /**
+     * Backwards compatibility: Always true. Ignored on insert/update
+     */
+    primary: boolean;
+    /**
+     * Order in which subtopic is sorted for the topic
+     */
+    rank: number;
+    /**
+     * Relevance id
+     */
+    relevanceId: string;
+}
+
+export interface TranslationPUT {
+    /**
+     * The translated name of the element. Used wherever translated texts are used.
+     */
+    name: string;
+}
+
+export interface UrlMapping {
+    /**
+     * URL for resource in old system
+     */
+    url: string;
+    /**
+     * Node URN for resource in new system
+     */
+    nodeId: string;
+    /**
+     * Subject URN for resource in new system (optional)
+     */
+    subjectId: string;
+}
+
+export interface SearchableTaxonomyResourceType {
+    id: string;
+    name: Record<string, string>;
+}
+
+export interface TaxonomyContext {
+    /**
+     * The publicId of the node connected via content-uri
+     */
+    publicId: string;
+    /**
+     * The publicId of the root parent of the context
+     */
+    rootId: string;
+    /**
+     * The name of the root parent of the context
+     */
+    root: Record<string, string>;
+    /**
+     * The context path
+     */
+    path: string;
+    /**
+     * A breadcrumb of the names of the context's path
+     */
+    breadcrumbs: Record<string, string[]>;
+    /**
+     * Whether a 'standard'-article, 'topic-article'-article or a 'learningpath'
+     */
+    contextType?: string;
+    /**
+     * Id of the relevance of the connection of the base
+     */
+    relevanceId: string;
+    /**
+     * Name of the relevance of the connection of the base
+     */
+    relevance: Record<string, string>;
+    /**
+     * Resource-types of the base
+     */
+    resourceTypes: SearchableTaxonomyResourceType[];
+    /**
+     * List of all parent topic-ids
+     */
+    parentIds: string[];
+    /**
+     * Whether the base connection is primary or not
+     */
+    isPrimary: boolean;
+    /**
+     * Whether the base connection is visible or not
+     */
+    isVisible: boolean;
+    /**
+     * Unique id of context based on root + connection
+     */
+    contextId: string;
+    id: string;
+    subject: Record<string, string>;
+    subjectId: string;
+    parentTopicIds: string[];
+    isPrimaryConnection: boolean;
+}
+
+export interface Connection {
+    connectionId: string;
+    targetId: string;
+    paths: string[];
+    type: string;
+    /**
+     * True if owned by this topic, false if it has its primary connection elsewhere
+     */
+    isPrimary: boolean;
+    primary: boolean;
+}
+
+export interface Metadata {
+    grepCodes: string[];
+    visible: boolean;
+    customFields: Record<string, string>;
+}
+
+export interface NodeChild extends Node {
+    parentId: string;
+    connectionId: string;
+    rank: number;
+    parent: string;
+    primary: boolean;
+}
+
+export interface Node {
+    id: string;
+    name: string;
+    contentUri?: string;
+    path: string;
+    paths: string[];
+    metadata: Metadata;
+    relevanceId: string;
+    translations: Translation[];
+    supportedLanguages: string[];
+    breadcrumbs: string[];
+    resourceTypes: ResourceTypeWithConnection[];
+    /**
+     * The type of node
+     */
+    nodeType: NodeType;
+    /**
+     * An id unique for this context.
+     */
+    contextId?: string;
+    url?: string;
+    contexts: TaxonomyContext[];
+}
+
+export interface NodeWithParents extends Node {
+    parents: NodeChild[];
+}
+
+export interface ResolvedUrl {
+    id: string;
+    contentUri: string;
+    name: string;
+    parents: string[];
+    path: string;
+}
+
+export interface ResourceTypeWithConnection {
+    id: string;
+    parentId: string;
+    name: string;
+    translations: Translation[];
+    /**
+     * List of language codes supported by translations
+     */
+    supportedLanguages: string[];
+    connectionId: string;
+}
+
+export interface SearchResult<T> {
+    totalCount: number;
+    page: number;
+    pageSize: number;
+    results: T[];
+}
+
+export interface Translation {
+    /**
+     * The translated name of the node
+     */
+    name: string;
+    /**
+     * ISO 639-1 language code
+     */
+    language: string;
+}
+
+export interface Version {
+    id: string;
+    versionType: VersionType;
+    name: string;
+    hash: string;
+    /**
+     * Is the version locked
+     */
+    locked: boolean;
+    created: DateAsString;
+    published?: DateAsString;
+    archived?: DateAsString;
+}
+
+export type DateAsString = string;
+
+export type NodeType = "NODE" | "SUBJECT" | "TOPIC" | "RESOURCE";
+
+export type VersionType = "BETA" | "PUBLISHED" | "ARCHIVED";

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "baseUrl": "src",
+    "target": "es5",
+    "esModuleInterop": true,
+    "outDir": "build",
+    "jsx": "react",
+    "isolatedModules": false,
+    "strict": true,
+    "moduleResolution": "node",
+    "declaration": true,
+    "noLib": false,
+    "noEmit": false,
+    "sourceMap": true,
+    "skipLibCheck": true,
+    "lib": [
+      "es2019",
+      "esnext.asynciterable",
+      "dom"
+    ],
+  }
+}