knowmax-quest-types 2.23.0 → 2.24.0

package/dist/ICollection.d.ts

@@ -1,15 +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[];
-}
+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/ICollection.js

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

package/dist/ICollectionDocumentReference.d.ts

@@ -1,8 +1,8 @@
-import { ICollection } from ".";
-export interface ICollectionDocumentReference {
-    collection: ICollection;
-    /** Describes version of document that is referenced from this collection. Null in case current version is referenced. */
-    version?: number;
-    /** Describes that document to which this collection document reference belongs is the actual version referenced. */
-    versionMatch: boolean;
-}
+import { ICollection } from ".";
+export interface ICollectionDocumentReference {
+    collection: ICollection;
+    /** Describes version of document that is referenced from this collection. Null in case current version is referenced. */
+    version?: number;
+    /** Describes that document to which this collection document reference belongs is the actual version referenced. */
+    versionMatch: boolean;
+}

package/dist/ICollectionDocumentReference.js

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

package/dist/ICollectionNode.d.ts

@@ -1,46 +1,46 @@
-export interface ICollectionNode<T extends ICollectionNode<T> = ICollectionNode<any>> {
-    /** Numeric identification of node. */
-    id: number;
-    /** Id of collection to which node belongs. */
-    collectionId: number;
-    /** Id of parent node. */
-    parentId?: number;
-    sequence: number;
-    title?: string;
-    description?: string;
-    /** Optional reference to a Quest document (without version specification). */
-    documentQuestId?: string;
-    /** Resolved numeric id of referenced document. */
-    documentId?: number;
-    /** Explicitly specified version. If omited the current version is assumed. */
-    documentVersion?: number;
-    customValue?: string;
-    customLicenseId?: string;
-    created: string;
-    createdBy: string;
-    modified: string;
-    modifiedBy: string;
-    /** Indicates if child nodes are available for this node. */
-    hasChilds: boolean;
-    /** Title of referenced Quest document. Either title of specific document version of document.  */
-    referencedTitle?: string;
-    /** Version of referenced Quest document. */
-    referencedVersion?: number;
-    /** Date of referenced Quest document. */
-    referencedDate?: string;
-    /** Indicates if referenced Quest document is valid. */
-    referenceValid?: boolean;
-    /** Indicates if referenced Quest document could be located exactly. */
-    referenceExact?: boolean;
-    /** Indicates if reference Quest document has a cover. */
-    referenceCover?: boolean;
-    /** Indicates if reference Quest document root node has child nodes. If false, this document only has contents on document root node. If true document has child nodes and thus a toc. */
-    referenceRootChildNodes?: boolean;
-    /** License information for user calling method that returns this CollectionNodeInfoEx. Only applies to nodes with a valid document reference. Possible values: Unknown, Enabled, Disabled. */
-    license?: string;
-    /** Indicates if this node or any node in it's childs is enabled by license (and thus has a valid document reference). */
-    hasLicenseEnabled?: boolean;
-    /** Indicates if this node or any node in it's childs is disabled by license (and thus has a valid document reference). */
-    hasLicenseDisabled?: boolean;
-    child?: T[];
-}
+export interface ICollectionNode<T extends ICollectionNode<T> = ICollectionNode<any>> {
+    /** Numeric identification of node. */
+    id: number;
+    /** Id of collection to which node belongs. */
+    collectionId: number;
+    /** Id of parent node. */
+    parentId?: number;
+    sequence: number;
+    title?: string;
+    description?: string;
+    /** Optional reference to a Quest document (without version specification). */
+    documentQuestId?: string;
+    /** Resolved numeric id of referenced document. */
+    documentId?: number;
+    /** Explicitly specified version. If omited the current version is assumed. */
+    documentVersion?: number;
+    customValue?: string;
+    customLicenseId?: string;
+    created: string;
+    createdBy: string;
+    modified: string;
+    modifiedBy: string;
+    /** Indicates if child nodes are available for this node. */
+    hasChilds: boolean;
+    /** Title of referenced Quest document. Either title of specific document version of document.  */
+    referencedTitle?: string;
+    /** Version of referenced Quest document. */
+    referencedVersion?: number;
+    /** Date of referenced Quest document. */
+    referencedDate?: string;
+    /** Indicates if referenced Quest document is valid. */
+    referenceValid?: boolean;
+    /** Indicates if referenced Quest document could be located exactly. */
+    referenceExact?: boolean;
+    /** Indicates if reference Quest document has a cover. */
+    referenceCover?: boolean;
+    /** Indicates if reference Quest document root node has child nodes. If false, this document only has contents on document root node. If true document has child nodes and thus a toc. */
+    referenceRootChildNodes?: boolean;
+    /** License information for user calling method that returns this CollectionNodeInfoEx. Only applies to nodes with a valid document reference. Possible values: Unknown, Enabled, Disabled. */
+    license?: string;
+    /** Indicates if this node or any node in it's childs is enabled by license (and thus has a valid document reference). */
+    hasLicenseEnabled?: boolean;
+    /** Indicates if this node or any node in it's childs is disabled by license (and thus has a valid document reference). */
+    hasLicenseDisabled?: boolean;
+    child?: T[];
+}

package/dist/ICollectionNode.js

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

package/dist/ICoverInfo.d.ts

@@ -1,8 +1,8 @@
-export interface ICoverInfo {
-    /** Document requested or document to which DocumentVersion requested belongs has cover image specified. */
-    documentAvailable: boolean;
-    documentMimeType?: string;
-    /** DocumentVersion requested has cover image specified. */
-    versionAvailable: boolean;
-    versionMimeType?: string;
-}
+export interface ICoverInfo {
+    /** Document requested or document to which DocumentVersion requested belongs has cover image specified. */
+    documentAvailable: boolean;
+    documentMimeType?: string;
+    /** DocumentVersion requested has cover image specified. */
+    versionAvailable: boolean;
+    versionMimeType?: string;
+}

package/dist/ICoverInfo.js

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

package/dist/ICoverOptions.d.ts

@@ -1,10 +1,10 @@
-/** Options for getting cover. */
-export interface ICoverOptions {
-    /** Return thumb instead of full image. Thumb will be of type JPG or SVG. Default true. */
-    thumb?: boolean;
-    /** If set to true only document version specific cover is returned. Otherwise allows to fall back to document specific image. Default false. */
-    versionSpecific?: boolean;
-    /** If set to true JSON reference info of requested document will be returned in case no cover image could be located.
-     * The reference info includes document meta info to allow the client to determine alternative image. Default false. */
-    softFail?: boolean;
-}
+/** Options for getting cover. */
+export interface ICoverOptions {
+    /** Return thumb instead of full image. Thumb will be of type JPG or SVG. Default true. */
+    thumb?: boolean;
+    /** If set to true only document version specific cover is returned. Otherwise allows to fall back to document specific image. Default false. */
+    versionSpecific?: boolean;
+    /** If set to true JSON reference info of requested document will be returned in case no cover image could be located.
+     * The reference info includes document meta info to allow the client to determine alternative image. Default false. */
+    softFail?: boolean;
+}

package/dist/ICoverOptions.js

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

package/dist/IDataCompare.d.ts

@@ -1,9 +1,9 @@
-import { IReferenceInfo } from '.';
-export interface IDataCompare {
-    referenceInfo1: IReferenceInfo;
-    referenceInfo2: IReferenceInfo;
-    /** True if versions are different. */
-    changed: boolean;
-    /** Html string with comparison of both references. */
-    html: string;
-}
+import { IReferenceInfo } from '.';
+export interface IDataCompare {
+    referenceInfo1: IReferenceInfo;
+    referenceInfo2: IReferenceInfo;
+    /** True if versions are different. */
+    changed: boolean;
+    /** Html string with comparison of both references. */
+    html: string;
+}

package/dist/IDataCompare.js

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

package/dist/IDataCompareOptions.d.ts

@@ -1,10 +1,10 @@
-/** Options for getting document data comparison. */
-export interface IDataCompareOptions {
-    id2: string;
-    allowOffline?: boolean;
-    allowInvalid?: boolean;
-    compose?: boolean | string;
-    transform?: string;
-    linkManager?: boolean;
-    linkManagerMode?: string;
-}
+/** Options for getting document data comparison. */
+export interface IDataCompareOptions {
+    id2: string;
+    allowOffline?: boolean;
+    allowInvalid?: boolean;
+    compose?: boolean | string;
+    transform?: string;
+    linkManager?: boolean;
+    linkManagerMode?: string;
+}

package/dist/IDataCompareOptions.js

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

package/dist/IDataOptions.d.ts

@@ -1,11 +1,11 @@
-/** Options for getting document data.  */
-export interface IDataOptions {
-    allowOffline?: boolean;
-    allowInvalid?: boolean;
-    compose?: boolean | string;
-    transform?: string;
-    linkManager?: boolean;
-    linkManagerMode?: string;
-    preview?: boolean | number;
-    previewImage?: string;
-}
+/** Options for getting document data.  */
+export interface IDataOptions {
+    allowOffline?: boolean;
+    allowInvalid?: boolean;
+    compose?: boolean | string;
+    transform?: string;
+    linkManager?: boolean;
+    linkManagerMode?: string;
+    preview?: boolean | number;
+    previewImage?: string;
+}

package/dist/IDataOptions.js

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

package/dist/IDocument.d.ts

@@ -1,19 +1,19 @@
-export interface IDocument {
-    /** Internal identification. */
-    id: number;
-    /** Public Quest identification. */
-    questId: string;
-    /** Document title. */
-    title: string;
-    /** Explicit marking of document and all it's versions as archive. Not set in case Quest should infer this value. */
-    archive?: boolean;
-    /** Internal identification of optional document group to which this document belongs. */
-    documentGroupId?: number;
-    /** Quest identification of optional document group to which this document belongs. */
-    documentGroupQuestId?: string;
-    modified: string;
-    modifiedBy: string;
-    created: string;
-    createdBy: string;
-}
-export type IDocumentEditable = Pick<IDocument, 'questId' | 'title' | 'archive' | 'documentGroupId'>;
+export interface IDocument {
+    /** Internal identification. */
+    id: number;
+    /** Public Quest identification. */
+    questId: string;
+    /** Document title. */
+    title: string;
+    /** Explicit marking of document and all it's versions as archive. Not set in case Quest should infer this value. */
+    archive?: boolean;
+    /** Internal identification of optional document group to which this document belongs. */
+    documentGroupId?: number;
+    /** Quest identification of optional document group to which this document belongs. */
+    documentGroupQuestId?: string;
+    modified: string;
+    modifiedBy: string;
+    created: string;
+    createdBy: string;
+}
+export type IDocumentEditable = Pick<IDocument, 'questId' | 'title' | 'archive' | 'documentGroupId'>;

package/dist/IDocument.js

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

package/dist/IDocumentAlternative.d.ts

@@ -1,16 +1,16 @@
-import { IDocumentNode, IDocumentVersion } from ".";
-export interface IDocumentAlternative {
-    id: number;
-    documentVersionId: number;
-    documentNodeId?: number;
-    label: string;
-    title?: string;
-    description?: string;
-    mimeType: string;
-    modified: string;
-    modifiedBy: string;
-    created: string;
-    createdBy: string;
-    documentNode?: IDocumentNode;
-    documentVersion?: IDocumentVersion;
-}
+import { IDocumentNode, IDocumentVersion } from ".";
+export interface IDocumentAlternative {
+    id: number;
+    documentVersionId: number;
+    documentNodeId?: number;
+    label: string;
+    title?: string;
+    description?: string;
+    mimeType: string;
+    modified: string;
+    modifiedBy: string;
+    created: string;
+    createdBy: string;
+    documentNode?: IDocumentNode;
+    documentVersion?: IDocumentVersion;
+}

package/dist/IDocumentAlternative.js

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

package/dist/IDocumentAlternativeInfo.d.ts

@@ -1,9 +1,9 @@
-export interface IDocumentAlternativeInfo {
-    id: number;
-    label: string;
-    title?: string;
-    description?: string;
-    mimeType: string;
-    /** Origin of document alternative. Possible values: DocumentVersion, DocumentNode */
-    origin: string;
-}
+export interface IDocumentAlternativeInfo {
+    id: number;
+    label: string;
+    title?: string;
+    description?: string;
+    mimeType: string;
+    /** Origin of document alternative. Possible values: DocumentVersion, DocumentNode */
+    origin: string;
+}

package/dist/IDocumentAlternativeInfo.js

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

package/dist/IDocumentGroup.d.ts

@@ -1,13 +1,13 @@
-export interface IDocumentGroup {
-    /** Internal identification. */
-    id: number;
-    /** Quest identification for document group. */
-    questId: string;
-    /** Document group title */
-    title?: string;
-    modified: string;
-    modifiedBy: string;
-    created: string;
-    createdBy: string;
-}
-export type IDocumentGroupEditable = Pick<IDocumentGroup, 'questId' | 'title'>;
+export interface IDocumentGroup {
+    /** Internal identification. */
+    id: number;
+    /** Quest identification for document group. */
+    questId: string;
+    /** Document group title */
+    title?: string;
+    modified: string;
+    modifiedBy: string;
+    created: string;
+    createdBy: string;
+}
+export type IDocumentGroupEditable = Pick<IDocumentGroup, 'questId' | 'title'>;

package/dist/IDocumentGroup.js

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

package/dist/IDocumentNode.d.ts

@@ -1,22 +1,22 @@
-import { IMetadata } from ".";
-export interface IDocumentNode<T extends IDocumentNode<T> = IDocumentNode<any>> {
-    /** Internal identification. */
-    id: number;
-    /** Public Quest identification. */
-    questId?: string;
-    /** Url to data for this node. */
-    url?: string;
-    /** Title for this document node. */
-    title?: string;
-    /** Describes Quest specific type for this document node. */
-    type: string;
-    /** True in case this document node is composable. Composable nodes can optionally be included in their parents data contents. */
-    composable: boolean;
-    /** Describes MIME type for data associated with this document node. */
-    mimeType?: string;
-    /** Describes ordinal sequence within other document nodes at same level. */
-    sequence: number;
-    /** Describes metadata for this document node. */
-    metadata?: IMetadata[];
-    child?: T[];
-}
+import { IMetadata } from ".";
+export interface IDocumentNode<T extends IDocumentNode<T> = IDocumentNode<any>> {
+    /** Internal identification. */
+    id: number;
+    /** Public Quest identification. */
+    questId?: string;
+    /** Url to data for this node. */
+    url?: string;
+    /** Title for this document node. */
+    title?: string;
+    /** Describes Quest specific type for this document node. */
+    type: string;
+    /** True in case this document node is composable. Composable nodes can optionally be included in their parents data contents. */
+    composable: boolean;
+    /** Describes MIME type for data associated with this document node. */
+    mimeType?: string;
+    /** Describes ordinal sequence within other document nodes at same level. */
+    sequence: number;
+    /** Describes metadata for this document node. */
+    metadata?: IMetadata[];
+    child?: T[];
+}

package/dist/IDocumentNode.js

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

package/dist/IDocumentPredecessor.d.ts

@@ -0,0 +1,13 @@
+export interface IDocumentPredecessor {
+    /** Internal identification. */
+    id: number;
+    /** Id of document of which predecessor is decribed. */
+    documentId: number;
+    /** QuestId of predecessor. */
+    documentQuestId: string;
+    modified: string;
+    modifiedBy: string;
+    created: string;
+    createdBy: string;
+}
+export type IDocumentPredecessorEditable = Pick<IDocumentPredecessor, 'documentId' | 'documentQuestId'>;

package/dist/IDocumentPredecessor.js

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

package/dist/IDocumentVersion.d.ts

@@ -1,42 +1,42 @@
-export interface IDocumentVersion {
-    /** Internal identification. */
-    id: number;
-    /** Version number of this document version. */
-    version: number;
-    /** Url to data for this document version. */
-    url: string;
-    /** Title for this specific document version in case it differs from title for document to which this version belongs. */
-    title?: string;
-    /** Date time for this document version. */
-    date: string;
-    /** Reflects inferred current version setting. It's either true because it was explicitly set as current document or
-     * because it was inferred because this document is the latest online version for a document without expliciet document version marked as current.
-     */
-    current: boolean;
-    /** Original - non inferred - current setting. Set to undefined for automatic inference by Knowmax Quest. */
-    originalCurrent?: boolean;
-    /** Reflects inferred value indiciating whether this version is considered archive. It's true in case document to which version belongs
-     * was explicitly marked archive or in case this version is older than current version for this document.
-    */
-    archive?: boolean;
-    /** Description as set for this document version. */
-    description?: string;
-    /** Quest importer responsible for importing this document version. */
-    importerId: string;
-    /** Describes if this document version contains any document nodes. */
-    hasNodes: boolean;
-    /** 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;
-    /** 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;
-    resourceCount: number;
-    messageCount: number;
-}
+export interface IDocumentVersion {
+    /** Internal identification. */
+    id: number;
+    /** Version number of this document version. */
+    version: number;
+    /** Url to data for this document version. */
+    url: string;
+    /** Title for this specific document version in case it differs from title for document to which this version belongs. */
+    title?: string;
+    /** Date time for this document version. */
+    date: string;
+    /** Reflects inferred current version setting. It's either true because it was explicitly set as current document or
+     * because it was inferred because this document is the latest online version for a document without expliciet document version marked as current.
+     */
+    current: boolean;
+    /** Original - non inferred - current setting. Set to undefined for automatic inference by Knowmax Quest. */
+    originalCurrent?: boolean;
+    /** Reflects inferred value indiciating whether this version is considered archive. It's true in case document to which version belongs
+     * was explicitly marked archive or in case this version is older than current version for this document.
+    */
+    archive?: boolean;
+    /** Description as set for this document version. */
+    description?: string;
+    /** Quest importer responsible for importing this document version. */
+    importerId: string;
+    /** Describes if this document version contains any document nodes. */
+    hasNodes: boolean;
+    /** 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;
+    /** 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;
+    resourceCount: number;
+    messageCount: number;
+}

package/dist/IDocumentVersion.js

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