knowmax-quest-types 2.9.0 → 2.11.0

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2021 Knowmax B.V.
+Copyright 2021-2023 Knowmax B.V.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/dist/ICollection.d.ts

@@ -1,11 +1,15 @@
+import { IMetadata } from '.';
 export interface ICollection {
     id: number;
     label: string;
     name: string;
     description?: string;
+    /** Optional quest id of document to which collection is associated. */
     associatedQuestId?: string;
     modified: string;
     modifiedBy: string;
     created: string;
     createdBy: string;
+    /** Optional metadata associated with colection. */
+    metadata?: IMetadata[];
 }

package/dist/IMetadataForQuestId.d.ts

@@ -1,4 +1,4 @@
-import { IMetadata } from ".";
+import { IMetadata } from '.';
 export interface IMetadataForQuestId {
     questId: string;
     /** List of metadata for document, document version or document node with given Quest id. */

package/dist/IMetadataValueSuggestion.d.ts

@@ -0,0 +1,13 @@
+/** Single result from /api/metadatavalue/suggest endpoint. */
+export interface IMetadataValueSuggestion {
+    /** Identification of metadata when requesting suggestions. Usually in format familylabel.label */
+    metadataDefinition: string;
+    /** Suggested values for metadata. */
+    values: IMetadataValueSuggestionItem[];
+}
+export interface IMetadataValueSuggestionItem {
+    /** Actual value. */
+    value: string;
+    /** Value with marking of query. */
+    highlightedValue: string;
+}

package/dist/IMetadataValueSuggestion.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -24,3 +24,4 @@ export * from './IReference';
 export * from './IDocumentAlternative';
 export * from './IMetadataForNodes';
 export * from './IMetadataForQuestId';
+export * from './IMetadataValueSuggestion';

package/dist/index.js

@@ -40,3 +40,4 @@ __exportStar(require("./IReference"), exports);
 __exportStar(require("./IDocumentAlternative"), exports);
 __exportStar(require("./IMetadataForNodes"), exports);
 __exportStar(require("./IMetadataForQuestId"), exports);
+__exportStar(require("./IMetadataValueSuggestion"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knowmax-quest-types",
-  "version": "2.9.0",
+  "version": "2.11.0",
   "description": "Contains type definitions for communicating with Knowmax Quest.",
   "main": "./dist/index.js",
   "scripts": {
@@ -19,12 +19,12 @@
   "author": "Knowmax BV",
   "license": "MIT",
   "devDependencies": {
-    "@types/chai": "4.3.3",
-    "@types/mocha": "9.1.0",
-    "chai": "4.3.6",
-    "mocha": "9.2.2",
-    "rimraf": "^3.0.2",
-    "ts-mocha": "9.0.2",
-    "typescript": "4.8.4"
+    "@types/chai": "4.3.4",
+    "@types/mocha": "10.0.1",
+    "chai": "4.3.7",
+    "mocha": "10.2.0",
+    "rimraf": "5.0.0",
+    "ts-mocha": "10.0.0",
+    "typescript": "4.9.5"
   }
 }