knowmax-quest-types 2.23.1 → 2.25.0

package/dist/IDocumentVersionWithDocumentInfo.d.ts

@@ -1,38 +1,38 @@
-/** Refelcts document version with key document info. Closely represents document version as stored in database. */
-export interface IDocumentVersionWithDocumentInfo {
-    /** Internal identification. */
-    id: number;
-    /** Internal identification for document to which version belongs. */
-    documentId: number;
-    /** Quest identification of document to which version belongs. */
-    questId: string;
-    /** Version number of this document version. */
-    version: number;
-    /** Title for this specific document version in case it differs from title for document to which this version belongs. */
-    title?: string;
-    /** Title of document to which this version belongs. */
-    documentTitle: string;
-    /** Date time for this document version. */
-    date: string;
-    /** Reflects optional setting for execlusive current version. Only one version which belongs to a document is allowed to be explicitly marked as current. If none
-     * is marked, automatic inference will be used to determine current version. */
-    current?: boolean;
-    /** Description as set for this document version. */
-    description?: string;
-    /** Quest importer responsible for importing this document version. */
-    importerId: string;
-    /** When false, this document only has contents on document root node. When true document has child nodes underneath document root node. */
-    documentRootChildNodes: boolean;
-    /** True in case document version is valid. */
-    valid: boolean;
-    /** True in case document version is online. */
-    online: boolean;
-    /** Set while document is being imported. */
-    importing?: boolean;
-    /** Origin identification as set during data import. Custom field to describe origin of data import. */
-    originId?: string;
-    modified: string;
-    modifiedBy: string;
-    created: string;
-    createdBy: string;
-}
+/** Refelcts document version with key document info. Closely represents document version as stored in database. */
+export interface IDocumentVersionWithDocumentInfo {
+    /** Internal identification. */
+    id: number;
+    /** Internal identification for document to which version belongs. */
+    documentId: number;
+    /** Quest identification of document to which version belongs. */
+    questId: string;
+    /** Version number of this document version. */
+    version: number;
+    /** Title for this specific document version in case it differs from title for document to which this version belongs. */
+    title?: string;
+    /** Title of document to which this version belongs. */
+    documentTitle: string;
+    /** Date time for this document version. */
+    date: string;
+    /** Reflects optional setting for execlusive current version. Only one version which belongs to a document is allowed to be explicitly marked as current. If none
+     * is marked, automatic inference will be used to determine current version. */
+    current?: boolean;
+    /** Description as set for this document version. */
+    description?: string;
+    /** Quest importer responsible for importing this document version. */
+    importerId: string;
+    /** When false, this document only has contents on document root node. When true document has child nodes underneath document root node. */
+    documentRootChildNodes: boolean;
+    /** True in case document version is valid. */
+    valid: boolean;
+    /** True in case document version is online. */
+    online: boolean;
+    /** Set while document is being imported. */
+    importing?: boolean;
+    /** Origin identification as set during data import. Custom field to describe origin of data import. */
+    originId?: string;
+    modified: string;
+    modifiedBy: string;
+    created: string;
+    createdBy: string;
+}

package/dist/IDocumentVersionWithDocumentInfo.js

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

package/dist/IDocumentWithVersionInfo.d.ts

@@ -1,6 +1,6 @@
-import { IDocument } from '.';
-export interface IDocumentWithVersionInfo extends IDocument {
-    versionCount: number;
-    firstVersion: string;
-    lastVersion: string;
-}
+import { IDocument } from '.';
+export interface IDocumentWithVersionInfo extends IDocument {
+    versionCount: number;
+    firstVersion: string;
+    lastVersion: string;
+}

package/dist/IDocumentWithVersionInfo.js

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

package/dist/IFavoriteInfo.d.ts

@@ -1,10 +1,10 @@
-export interface IFavoriteInfo {
-    /** Reference is a direct favorite. */
-    exact: boolean;
-    /** Document is direct favorite or user has a favorite in document. */
-    document: boolean;
-    /** DocumentVersion is direct favorite or user has favorite in documentVersion. */
-    documentVersion: boolean;
-    /** DocumentNode is direct favorite. Must be an exact match. */
-    documentNode: boolean;
-}
+export interface IFavoriteInfo {
+    /** Reference is a direct favorite. */
+    exact: boolean;
+    /** Document is direct favorite or user has a favorite in document. */
+    document: boolean;
+    /** DocumentVersion is direct favorite or user has favorite in documentVersion. */
+    documentVersion: boolean;
+    /** DocumentNode is direct favorite. Must be an exact match. */
+    documentNode: boolean;
+}

package/dist/IFavoriteInfo.js

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

package/dist/IImportLog.d.ts

@@ -1,13 +1,13 @@
-import { IDocumentNode, IDocumentVersion } from ".";
-export interface IImportlog {
-    id: number;
-    documentVersionId: number;
-    documentNodeId?: number;
-    type: string;
-    subject: string;
-    message: string;
-    details: string;
-    created: string;
-    documentNode?: IDocumentNode;
-    documentVersion?: IDocumentVersion;
-}
+import { IDocumentNode, IDocumentVersion } from ".";
+export interface IImportlog {
+    id: number;
+    documentVersionId: number;
+    documentNodeId?: number;
+    type: string;
+    subject: string;
+    message: string;
+    details: string;
+    created: string;
+    documentNode?: IDocumentNode;
+    documentVersion?: IDocumentVersion;
+}

package/dist/IImportLog.js

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

package/dist/IListRequest.d.ts

@@ -1,9 +1,9 @@
-/** Decribes request for lists from API. */
-export interface IListRequest {
-    orderBy?: string;
-    search?: string;
-    filter?: string;
-    take?: number;
-    skip: number;
-    count: boolean;
-}
+/** Decribes request for lists from API. */
+export interface IListRequest {
+    orderBy?: string;
+    search?: string;
+    filter?: string;
+    take?: number;
+    skip: number;
+    count: boolean;
+}

package/dist/IListRequest.js

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

package/dist/IMetadata.d.ts

@@ -1,9 +1,9 @@
-export interface IMetadata {
-    familyLabel: string;
-    label: string;
-    value: string;
-    dataTypeHint?: string;
-    description?: string;
-    /** Origin of value. Possible values: Document, DocumentVersion, DocumentNode, Dynamic, DynamicIndexable, Collection */
-    origin?: string;
-}
+export interface IMetadata {
+    familyLabel: string;
+    label: string;
+    value: string;
+    dataTypeHint?: string;
+    description?: string;
+    /** Origin of value. Possible values: Document, DocumentVersion, DocumentNode, Dynamic, DynamicIndexable, Collection */
+    origin?: string;
+}

package/dist/IMetadata.js

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

package/dist/IMetadataForNodes.d.ts

@@ -1,10 +1,10 @@
-import { IMetadataForQuestId } from ".";
-/** Metadata for a collection of nodes within a document version. */
-export interface IMetadataForNodes {
-    /** Identification of document to which these nodes belong. Without version specification. */
-    questId: string;
-    /** Version number of document version to which these nodes belong. */
-    version: number;
-    /** All hierarchically child nodes of document node specified by questId. */
-    nodes: IMetadataForQuestId[];
-}
+import { IMetadataForQuestId } from ".";
+/** Metadata for a collection of nodes within a document version. */
+export interface IMetadataForNodes {
+    /** Identification of document to which these nodes belong. Without version specification. */
+    questId: string;
+    /** Version number of document version to which these nodes belong. */
+    version: number;
+    /** All hierarchically child nodes of document node specified by questId. */
+    nodes: IMetadataForQuestId[];
+}

package/dist/IMetadataForNodes.js

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

package/dist/IMetadataForQuestId.d.ts

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

package/dist/IMetadataForQuestId.js

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

package/dist/IMetadataValueSuggestion.d.ts

@@ -1,13 +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;
-}
+/** 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

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

package/dist/IReference.d.ts

@@ -1,12 +1,12 @@
-import { IDocumentNode, IDocumentVersion } from ".";
-export interface IReference {
-    id: number;
-    documentVersionId: number;
-    documentNodeId?: number;
-    type: string;
-    value: string;
-    domain: string;
-    count: number;
-    documentNode?: IDocumentNode;
-    documentVersion?: IDocumentVersion;
-}
+import { IDocumentNode, IDocumentVersion } from ".";
+export interface IReference {
+    id: number;
+    documentVersionId: number;
+    documentNodeId?: number;
+    type: string;
+    value: string;
+    domain: string;
+    count: number;
+    documentNode?: IDocumentNode;
+    documentVersion?: IDocumentVersion;
+}

package/dist/IReference.js

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

package/dist/IReferenceInfo.d.ts

@@ -1,45 +1,45 @@
-import { IDocument, IDocumentVersion, IDocumentNode, IMetadata, IFavoriteInfo, ICollectionDocumentReference, ICoverInfo, IResource, IDocumentAlternativeInfo } from '.';
-export interface IReferenceInfo<T extends IDocumentNode<T> = IDocumentNode<any>> {
-    /** Originally requested Quest id. */
-    requestedQuestId: string;
-    /** Quest id after parsing. */
-    parsedQuestId: string;
-    /** Contains last part of Quest id in case reference was partly located but last part could not be located. */
-    questIdLeftover?: string;
-    /** Contains located reference. In case a version was specified, it includes explicit version number. */
-    questId: string;
-    /** True if requested item was exactly located. */
-    located: boolean;
-    /** Contains type of reference located. */
-    type: string;
-    /** Set in case of error while resolving reference. Possible values: InvalidInput, InvalidIdentification, DocumentNotFound, DocumentVersionNotFound, DocumentNodeNotFound, DocumentAlternativeNotFound. */
-    error?: string;
-    /** Document referenced by Quest id. */
-    document?: IDocument;
-    /** Document version referenced by Quest id (if any). */
-    documentVersion?: IDocumentVersion;
-    /** Document node referenced by Quest id (if any). */
-    documentNode?: T;
-    /** Resource referenced by Quest id (if any). */
-    resource?: IResource;
-    /** Info about document alternative referenced by Quest id (if any). */
-    documentAlternative?: IDocumentAlternativeInfo;
-    /** Metadata that belongs to Quest id (if requested). */
-    metadata: IMetadata[];
-    /** Collections in which document referenced by Quest id occurs (if requested). */
-    collections: ICollectionDocumentReference[];
-    /** List of info about document alternatives referenced by Quest id (if requested). */
-    documentAlternativesInfo?: IDocumentAlternativeInfo[];
-    /** Information about cover image for document and/or documentversion specified by Quest id (if requested). */
-    coverInfo?: ICoverInfo;
-    /** Set for user calling this method. Only for users authenticated by Knowmax License System. Possible values: Unknown, Enabled, Disabled */
-    licenseItemAccess?: string;
-    /** Security labels for document. Only for users authenticated by Knowmax License System. */
-    securityLabels?: string[];
-    /** Set for user calling this method. Only for users with a custom identity in an associated application. */
-    favoriteInfo?: IFavoriteInfo;
-    /** Key for this document version in search index. */
-    documentVersionIndexKey?: string;
-    /** Key for this document node in search index. */
-    documentNodeIndexKey?: string;
-}
+import { IDocument, IDocumentVersion, IDocumentNode, IMetadata, IFavoriteInfo, ICollectionDocumentReference, ICoverInfo, IResource, IDocumentAlternativeInfo } from '.';
+export interface IReferenceInfo<T extends IDocumentNode<T> = IDocumentNode<any>> {
+    /** Originally requested Quest id. */
+    requestedQuestId: string;
+    /** Quest id after parsing. */
+    parsedQuestId: string;
+    /** Contains last part of Quest id in case reference was partly located but last part could not be located. */
+    questIdLeftover?: string;
+    /** Contains located reference. In case a version was specified, it includes explicit version number. */
+    questId: string;
+    /** True if requested item was exactly located. */
+    located: boolean;
+    /** Contains type of reference located. */
+    type: string;
+    /** Set in case of error while resolving reference. Possible values: InvalidInput, InvalidIdentification, DocumentNotFound, DocumentVersionNotFound, DocumentNodeNotFound, DocumentAlternativeNotFound. */
+    error?: string;
+    /** Document referenced by Quest id. */
+    document?: IDocument;
+    /** Document version referenced by Quest id (if any). */
+    documentVersion?: IDocumentVersion;
+    /** Document node referenced by Quest id (if any). */
+    documentNode?: T;
+    /** Resource referenced by Quest id (if any). */
+    resource?: IResource;
+    /** Info about document alternative referenced by Quest id (if any). */
+    documentAlternative?: IDocumentAlternativeInfo;
+    /** Metadata that belongs to Quest id (if requested). */
+    metadata: IMetadata[];
+    /** Collections in which document referenced by Quest id occurs (if requested). */
+    collections: ICollectionDocumentReference[];
+    /** List of info about document alternatives referenced by Quest id (if requested). */
+    documentAlternativesInfo?: IDocumentAlternativeInfo[];
+    /** Information about cover image for document and/or documentversion specified by Quest id (if requested). */
+    coverInfo?: ICoverInfo;
+    /** Set for user calling this method. Only for users authenticated by Knowmax License System. Possible values: Unknown, Enabled, Disabled */
+    licenseItemAccess?: string;
+    /** Security labels for document. Only for users authenticated by Knowmax License System. */
+    securityLabels?: string[];
+    /** Set for user calling this method. Only for users with a custom identity in an associated application. */
+    favoriteInfo?: IFavoriteInfo;
+    /** Key for this document version in search index. */
+    documentVersionIndexKey?: string;
+    /** Key for this document node in search index. */
+    documentNodeIndexKey?: string;
+}

package/dist/IReferenceInfo.js

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

package/dist/IReferenceInfo.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/IReferenceInfo.test.js

@@ -1,49 +1,49 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const chai_1 = require("chai");
-it('IReference works without generic', () => {
-    const info = {
-        requestedQuestId: '',
-        parsedQuestId: '',
-        questId: '',
-        located: true,
-        type: '',
-        document: {
-            created: '',
-            createdBy: '',
-            id: 0,
-            questId: '',
-            title: '',
-            modified: '',
-            modifiedBy: ''
-        },
-        documentVersion: {
-            modifiedBy: '',
-            online: true,
-            modified: '',
-            createdBy: '',
-            created: '',
-            current: true,
-            id: 0,
-            date: '',
-            hasNodes: false,
-            documentRootChildNodes: false,
-            importerId: '',
-            messageCount: 0,
-            originId: '',
-            resourceCount: 0,
-            url: '',
-            valid: true,
-            version: 1
-        },
-        documentNode: {
-            id: 0,
-            type: '',
-            composable: false,
-            sequence: 0
-        },
-        metadata: [],
-        collections: [],
-    };
-    chai_1.assert.isDefined(info);
-});
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+it('IReference works without generic', () => {
+    const info = {
+        requestedQuestId: '',
+        parsedQuestId: '',
+        questId: '',
+        located: true,
+        type: '',
+        document: {
+            created: '',
+            createdBy: '',
+            id: 0,
+            questId: '',
+            title: '',
+            modified: '',
+            modifiedBy: ''
+        },
+        documentVersion: {
+            modifiedBy: '',
+            online: true,
+            modified: '',
+            createdBy: '',
+            created: '',
+            current: true,
+            id: 0,
+            date: '',
+            hasNodes: false,
+            documentRootChildNodes: false,
+            importerId: '',
+            messageCount: 0,
+            originId: '',
+            resourceCount: 0,
+            url: '',
+            valid: true,
+            version: 1
+        },
+        documentNode: {
+            id: 0,
+            type: '',
+            composable: false,
+            sequence: 0
+        },
+        metadata: [],
+        collections: [],
+    };
+    chai_1.assert.isDefined(info);
+});

package/dist/IReferenceInfoOptions.d.ts

@@ -1,26 +1,26 @@
-export interface IReferenceInfoOptions {
-    /** Get information for document versions marked offline. Specific version required. */
-    allowOffline?: boolean;
-    /** Get information for document versions marked invalid. Specific version required. */
-    allowInvalid?: boolean;
-    /** Include information about requested version. */
-    includeDocumentVersion?: boolean;
-    /** Include information about requested resource. */
-    includeResource?: boolean;
-    /** Include information about requested document node. */
-    includeDocumentNode?: boolean;
-    /** Include information about requested document alternative. */
-    includeDocumentAlternative?: boolean;
-    /** Include metadata. */
-    includeMetadata?: boolean;
-    /** Include collections in which document exists. */
-    includeCollections?: boolean;
-    /** Include availability information about cover image. */
-    includeCoverInfo?: boolean;
-    /** Include archive status of document version. Make sure to set includeDocumentVersion to true if archive value is required. */
-    includeDocumentVersionArchive?: boolean;
-    /** Include information about available document alternatives at level of reference (either documentversion of documentnode). */
-    includeDocumentAlternativesInfo?: boolean;
-    /** Include information about optional document group to which document referenced belongs. */
-    includeDocumentGroup?: boolean;
-}
+export interface IReferenceInfoOptions {
+    /** Get information for document versions marked offline. Specific version required. */
+    allowOffline?: boolean;
+    /** Get information for document versions marked invalid. Specific version required. */
+    allowInvalid?: boolean;
+    /** Include information about requested version. */
+    includeDocumentVersion?: boolean;
+    /** Include information about requested resource. */
+    includeResource?: boolean;
+    /** Include information about requested document node. */
+    includeDocumentNode?: boolean;
+    /** Include information about requested document alternative. */
+    includeDocumentAlternative?: boolean;
+    /** Include metadata. */
+    includeMetadata?: boolean;
+    /** Include collections in which document exists. */
+    includeCollections?: boolean;
+    /** Include availability information about cover image. */
+    includeCoverInfo?: boolean;
+    /** Include archive status of document version. Make sure to set includeDocumentVersion to true if archive value is required. */
+    includeDocumentVersionArchive?: boolean;
+    /** Include information about available document alternatives at level of reference (either documentversion of documentnode). */
+    includeDocumentAlternativesInfo?: boolean;
+    /** Include information about optional document group to which document referenced belongs. */
+    includeDocumentGroup?: boolean;
+}

package/dist/IReferenceInfoOptions.js

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

package/dist/IResource.d.ts

@@ -1,21 +1,21 @@
-import { IDocumentVersion } from ".";
-export interface IResource {
-    /** Internal identification. */
-    id: number;
-    /** Internal id of document version to which resource belongs. */
-    documentVersionId: number;
-    /** Name of resource. */
-    name: string;
-    /** Url to data for this resource. */
-    url: string;
-    /** Title of this resource. */
-    title: string;
-    /** Size in bytes of this resource. */
-    size: number;
-    /** MIME type which describes data associated with this resource. */
-    mimeType: string;
-    /** Optional group identification to which resource belongs. */
-    group?: string;
-    /** Document version info. If requested. */
-    documentVersion?: IDocumentVersion;
-}
+import { IDocumentVersion } from ".";
+export interface IResource {
+    /** Internal identification. */
+    id: number;
+    /** Internal id of document version to which resource belongs. */
+    documentVersionId: number;
+    /** Name of resource. */
+    name: string;
+    /** Url to data for this resource. */
+    url: string;
+    /** Title of this resource. */
+    title: string;
+    /** Size in bytes of this resource. */
+    size: number;
+    /** MIME type which describes data associated with this resource. */
+    mimeType: string;
+    /** Optional group identification to which resource belongs. */
+    group?: string;
+    /** Document version info. If requested. */
+    documentVersion?: IDocumentVersion;
+}