knowmax-quest-types 2.8.2 → 2.10.0

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.
package/LICENSE CHANGED
@@ -1,4 +1,4 @@
1
- Copyright 2021 Knowmax B.V.
1
+ Copyright 2021-2023 Knowmax B.V.
2
2
 
3
3
  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:
4
4
 
@@ -1,11 +1,15 @@
1
+ import { IMetadata } from '.';
1
2
  export interface ICollection {
2
3
  id: number;
3
4
  label: string;
4
5
  name: string;
5
6
  description?: string;
7
+ /** Optional quest id of document to which collection is associated. */
6
8
  associatedQuestId?: string;
7
9
  modified: string;
8
10
  modifiedBy: string;
9
11
  created: string;
10
12
  createdBy: string;
13
+ /** Optional metadata associated with colection. */
14
+ metadata?: IMetadata[];
11
15
  }
@@ -4,5 +4,5 @@ export interface IMetadata {
4
4
  value: string;
5
5
  dataTypeHint?: string;
6
6
  /** Origin of value. Possible values: Document, DocumentVersion, DocumentNode, Dynamic, DynamicIndexable, Collection */
7
- origin: string;
7
+ origin?: string;
8
8
  }
@@ -0,0 +1,10 @@
1
+ import { IMetadataForQuestId } from ".";
2
+ /** Metadata for a collection of nodes within a document version. */
3
+ export interface IMetadataForNodes {
4
+ /** Identification of document to which these nodes belong. Without version specification. */
5
+ questId: string;
6
+ /** Version number of document version to which these nodes belong. */
7
+ version: number;
8
+ /** All hierarchically child nodes of document node specified by questId. */
9
+ nodes: IMetadataForQuestId[];
10
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,6 @@
1
+ import { IMetadata } from '.';
2
+ export interface IMetadataForQuestId {
3
+ questId: string;
4
+ /** List of metadata for document, document version or document node with given Quest id. */
5
+ list: IMetadata[];
6
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
package/dist/index.d.ts CHANGED
@@ -22,3 +22,5 @@ export * from './IResource';
22
22
  export * from './IImportLog';
23
23
  export * from './IReference';
24
24
  export * from './IDocumentAlternative';
25
+ export * from './IMetadataForNodes';
26
+ export * from './IMetadataForQuestId';
package/dist/index.js CHANGED
@@ -38,3 +38,5 @@ __exportStar(require("./IResource"), exports);
38
38
  __exportStar(require("./IImportLog"), exports);
39
39
  __exportStar(require("./IReference"), exports);
40
40
  __exportStar(require("./IDocumentAlternative"), exports);
41
+ __exportStar(require("./IMetadataForNodes"), exports);
42
+ __exportStar(require("./IMetadataForQuestId"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "knowmax-quest-types",
3
- "version": "2.8.2",
3
+ "version": "2.10.0",
4
4
  "description": "Contains type definitions for communicating with Knowmax Quest.",
5
5
  "main": "./dist/index.js",
6
6
  "scripts": {
@@ -19,12 +19,12 @@
19
19
  "author": "Knowmax BV",
20
20
  "license": "MIT",
21
21
  "devDependencies": {
22
- "@types/chai": "4.3.0",
22
+ "@types/chai": "4.3.3",
23
23
  "@types/mocha": "9.1.0",
24
- "chai": "^4.3.6",
24
+ "chai": "4.3.6",
25
25
  "mocha": "9.2.2",
26
26
  "rimraf": "^3.0.2",
27
27
  "ts-mocha": "9.0.2",
28
- "typescript": "4.7.4"
28
+ "typescript": "4.8.4"
29
29
  }
30
30
  }