@twin.org/document-management-models 0.0.1-next.8 → 0.0.1

package/dist/cjs/index.cjs

@@ -1,5 +1,7 @@
 'use strict';
 
+var dataCore = require('@twin.org/data-core');
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -31,12 +33,158 @@ const DocumentTypes = {
     /**
      * Represents a document attestation.
      */
-    DocumentAttestation: "DocumentAttestation",
+    DocumentAttestation: "DocumentAttestation"
+};
+
+var $schema = "https://json-schema.org/draft/2020-12/schema";
+var $id = "https://schema.twindev.org/documents/Document";
+var description = "Interface describing a document.";
+var type = "object";
+var properties = {
+	"@context": {
+		type: "array",
+		minItems: 3,
+		items: {
+			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+		},
+		description: "JSON-LD Context.",
+		prefixItems: [
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/documents/"
+			},
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/common/"
+			},
+			{
+				type: "string",
+				"const": "https://schema.org"
+			}
+		]
+	},
+	type: {
+		type: "string",
+		"const": "Document",
+		description: "JSON-LD Type."
+	},
+	id: {
+		type: "string",
+		description: "The full id of the document."
+	},
+	documentId: {
+		type: "string",
+		description: "The id of the document."
+	},
+	documentIdFormat: {
+		type: "string",
+		description: "The format of the document id."
+	},
+	documentCode: {
+		$ref: "https://vocabulary.uncefact.org/DocumentCodeList",
+		description: "The code for the document type."
+	},
+	documentRevision: {
+		type: "number",
+		description: "The revision of the document as a 0 based index."
+	},
+	annotationObject: {
+		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
+		description: "Additional annotation information for the document."
+	},
+	blobStorageId: {
+		type: "string",
+		description: "The blob storage id for the document."
+	},
+	blobHash: {
+		type: "string",
+		description: "The hash of the blob data."
+	},
+	blobStorageEntry: {
+		$ref: "https://schema.twindev.org/blob-storage/BlobStorageEntry",
+		description: "The additional JSON-LD for blob storage if it was requested."
+	},
+	extractedData: {
+		description: "The data extracted from the document using data extraction services."
+	},
+	attestationId: {
+		type: "string",
+		description: "The attestation for the document if one was created."
+	},
+	attestationInformation: {
+		$ref: "https://schema.twindev.org/attestation/AttestationInformation",
+		description: "The additional JSON-LD for attestation storage if it was requested."
+	},
+	dateCreated: {
+		type: "string",
+		description: "The date/time of when the document was created."
+	},
+	dateModified: {
+		type: "string",
+		description: "The date/time of when the document was modified."
+	},
+	dateDeleted: {
+		type: "string",
+		description: "The date/time of when the document was deleted, as we never actually remove items."
+	},
+	nodeIdentity: {
+		type: "string",
+		description: "The node which added the document to the graph."
+	},
+	userIdentity: {
+		type: "string",
+		description: "The user who added the document to the graph."
+	}
+};
+var required = [
+	"@context",
+	"type",
+	"id",
+	"documentId",
+	"documentCode",
+	"documentRevision",
+	"blobStorageId",
+	"blobHash",
+	"dateCreated",
+	"nodeIdentity",
+	"userIdentity"
+];
+var additionalProperties = false;
+var DocumentSchema = {
+	$schema: $schema,
+	$id: $id,
+	description: description,
+	type: type,
+	properties: properties,
+	required: required,
+	additionalProperties: additionalProperties
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Handle all the data types for document management.
+ */
+class DocumentManagementDataTypes {
     /**
-     * Represents a document list.
+     * Register all the data types.
      */
-    DocumentList: "DocumentList"
-};
+    static registerTypes() {
+        dataCore.DataTypeHandlerFactory.register(`${DocumentContexts.ContextRoot}${DocumentTypes.Document}`, () => ({
+            context: DocumentContexts.ContextRoot,
+            type: DocumentTypes.Document,
+            defaultValue: {},
+            jsonSchema: async () => DocumentSchema
+        }));
+        dataCore.DataTypeHandlerFactory.register(`${DocumentContexts.ContextRoot}${DocumentTypes.DocumentAttestation}`, () => ({
+            context: DocumentContexts.ContextRoot,
+            type: DocumentTypes.DocumentAttestation,
+            defaultValue: {},
+            jsonSchema: async () => DocumentSchema
+        }));
+    }
+}
 
 exports.DocumentContexts = DocumentContexts;
+exports.DocumentManagementDataTypes = DocumentManagementDataTypes;
 exports.DocumentTypes = DocumentTypes;

package/dist/esm/index.mjs

@@ -1,3 +1,5 @@
+import { DataTypeHandlerFactory } from '@twin.org/data-core';
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -29,11 +31,156 @@ const DocumentTypes = {
     /**
      * Represents a document attestation.
      */
-    DocumentAttestation: "DocumentAttestation",
+    DocumentAttestation: "DocumentAttestation"
+};
+
+var $schema = "https://json-schema.org/draft/2020-12/schema";
+var $id = "https://schema.twindev.org/documents/Document";
+var description = "Interface describing a document.";
+var type = "object";
+var properties = {
+	"@context": {
+		type: "array",
+		minItems: 3,
+		items: {
+			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+		},
+		description: "JSON-LD Context.",
+		prefixItems: [
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/documents/"
+			},
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/common/"
+			},
+			{
+				type: "string",
+				"const": "https://schema.org"
+			}
+		]
+	},
+	type: {
+		type: "string",
+		"const": "Document",
+		description: "JSON-LD Type."
+	},
+	id: {
+		type: "string",
+		description: "The full id of the document."
+	},
+	documentId: {
+		type: "string",
+		description: "The id of the document."
+	},
+	documentIdFormat: {
+		type: "string",
+		description: "The format of the document id."
+	},
+	documentCode: {
+		$ref: "https://vocabulary.uncefact.org/DocumentCodeList",
+		description: "The code for the document type."
+	},
+	documentRevision: {
+		type: "number",
+		description: "The revision of the document as a 0 based index."
+	},
+	annotationObject: {
+		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
+		description: "Additional annotation information for the document."
+	},
+	blobStorageId: {
+		type: "string",
+		description: "The blob storage id for the document."
+	},
+	blobHash: {
+		type: "string",
+		description: "The hash of the blob data."
+	},
+	blobStorageEntry: {
+		$ref: "https://schema.twindev.org/blob-storage/BlobStorageEntry",
+		description: "The additional JSON-LD for blob storage if it was requested."
+	},
+	extractedData: {
+		description: "The data extracted from the document using data extraction services."
+	},
+	attestationId: {
+		type: "string",
+		description: "The attestation for the document if one was created."
+	},
+	attestationInformation: {
+		$ref: "https://schema.twindev.org/attestation/AttestationInformation",
+		description: "The additional JSON-LD for attestation storage if it was requested."
+	},
+	dateCreated: {
+		type: "string",
+		description: "The date/time of when the document was created."
+	},
+	dateModified: {
+		type: "string",
+		description: "The date/time of when the document was modified."
+	},
+	dateDeleted: {
+		type: "string",
+		description: "The date/time of when the document was deleted, as we never actually remove items."
+	},
+	nodeIdentity: {
+		type: "string",
+		description: "The node which added the document to the graph."
+	},
+	userIdentity: {
+		type: "string",
+		description: "The user who added the document to the graph."
+	}
+};
+var required = [
+	"@context",
+	"type",
+	"id",
+	"documentId",
+	"documentCode",
+	"documentRevision",
+	"blobStorageId",
+	"blobHash",
+	"dateCreated",
+	"nodeIdentity",
+	"userIdentity"
+];
+var additionalProperties = false;
+var DocumentSchema = {
+	$schema: $schema,
+	$id: $id,
+	description: description,
+	type: type,
+	properties: properties,
+	required: required,
+	additionalProperties: additionalProperties
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Handle all the data types for document management.
+ */
+class DocumentManagementDataTypes {
     /**
-     * Represents a document list.
+     * Register all the data types.
      */
-    DocumentList: "DocumentList"
-};
+    static registerTypes() {
+        DataTypeHandlerFactory.register(`${DocumentContexts.ContextRoot}${DocumentTypes.Document}`, () => ({
+            context: DocumentContexts.ContextRoot,
+            type: DocumentTypes.Document,
+            defaultValue: {},
+            jsonSchema: async () => DocumentSchema
+        }));
+        DataTypeHandlerFactory.register(`${DocumentContexts.ContextRoot}${DocumentTypes.DocumentAttestation}`, () => ({
+            context: DocumentContexts.ContextRoot,
+            type: DocumentTypes.DocumentAttestation,
+            defaultValue: {},
+            jsonSchema: async () => DocumentSchema
+        }));
+    }
+}
 
-export { DocumentContexts, DocumentTypes };
+export { DocumentContexts, DocumentManagementDataTypes, DocumentTypes };

package/dist/types/dataTypes/documentManagementDataTypes.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Handle all the data types for document management.
+ */
+export declare class DocumentManagementDataTypes {
+    /**
+     * Register all the data types.
+     */
+    static registerTypes(): void;
+}

package/dist/types/index.d.ts

@@ -1,9 +1,13 @@
+export * from "./dataTypes/documentManagementDataTypes";
+export * from "./models/api/IDocumentManagementCreateRequest";
 export * from "./models/api/IDocumentManagementGetRequest";
 export * from "./models/api/IDocumentManagementGetResponse";
+export * from "./models/api/IDocumentManagementGetRevisionRequest";
+export * from "./models/api/IDocumentManagementGetRevisionResponse";
 export * from "./models/api/IDocumentManagementQueryRequest";
 export * from "./models/api/IDocumentManagementQueryResponse";
 export * from "./models/api/IDocumentManagementRemoveRequest";
-export * from "./models/api/IDocumentManagementSetRequest";
+export * from "./models/api/IDocumentManagementUpdateRequest";
 export * from "./models/documentContexts";
 export * from "./models/documentTypes";
 export * from "./models/IDocument";

package/dist/types/models/IDocument.d.ts

@@ -58,6 +58,10 @@ export interface IDocument {
      * The additional JSON-LD for blob storage if it was requested.
      */
     blobStorageEntry?: IBlobStorageEntry;
+    /**
+     * The data extracted from the document using data extraction services.
+     */
+    extractedData?: unknown;
     /**
      * The attestation for the document if one was created.
      */
@@ -86,12 +90,4 @@ export interface IDocument {
      * The user who added the document to the graph.
      */
     userIdentity: string;
-    /**
-     * The previous revisions of the document.
-     */
-    revisions?: IDocument[];
-    /**
-     * The cursor to get the next chunk of revisions.
-     */
-    revisionCursor?: string;
 }

package/dist/types/models/IDocumentList.d.ts

@@ -1,6 +1,6 @@
 import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
+import type { SchemaOrgContexts, SchemaOrgTypes } from "@twin.org/standards-schema-org";
 import type { DocumentContexts } from "./documentContexts";
-import type { DocumentTypes } from "./documentTypes";
 import type { IDocument } from "./IDocument";
 /**
  * Interface describing a list of document entries.
@@ -10,6 +10,7 @@ export interface IDocumentList {
      * JSON-LD Context.
      */
     "@context": [
+        typeof SchemaOrgContexts.ContextRoot,
         typeof DocumentContexts.ContextRoot,
         typeof DocumentContexts.ContextRootCommon,
         ...IJsonLdContextDefinitionElement[]
@@ -17,13 +18,17 @@ export interface IDocumentList {
     /**
      * JSON-LD Type.
      */
-    type: typeof DocumentTypes.DocumentList;
+    type: typeof SchemaOrgTypes.ItemList;
     /**
      * The list of documents.
      */
-    documents: IDocument[];
+    [SchemaOrgTypes.ItemListElement]: IDocument[];
+    /**
+     * The ids of the other vertices which are connected to the document.
+     */
+    edges?: string[];
     /**
      * The cursor to get the next chunk of documents.
      */
-    cursor?: string;
+    [SchemaOrgTypes.NextItem]?: string;
 }

package/dist/types/models/IDocumentManagementComponent.d.ts

@@ -1,3 +1,4 @@
+import type { IAuditableItemGraphVertexList } from "@twin.org/auditable-item-graph-models";
 import type { IComponent } from "@twin.org/core";
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { UneceDocumentCodes } from "@twin.org/standards-unece";
@@ -8,78 +9,112 @@ import type { IDocumentList } from "./IDocumentList";
  */
 export interface IDocumentManagementComponent extends IComponent {
     /**
-     * Store a document in an auditable item graph vertex and add its content to blob storage.
+     * Create a document as an auditable item graph vertex and add its content to blob storage.
      * If the document id already exists and the blob data is different a new revision will be created.
      * For any other changes the current revision will be updated.
-     * @param auditableItemGraphId The auditable item graph vertex id to create the document on.
      * @param documentId The document id to create.
      * @param documentIdFormat The format of the document identifier.
      * @param documentCode The code for the document type.
      * @param blob The data to create the document with.
      * @param annotationObject Additional information to associate with the document.
+     * @param auditableItemGraphEdges The auditable item graph vertices to connect the document to.
      * @param options Additional options for the set operation.
      * @param options.createAttestation Flag to create an attestation for the document, defaults to false.
-     * @param options.includeIdAsAlias Include the document id as an alias to the aig vertex, defaults to false.
-     * @param options.aliasAnnotationObject Additional information to associate with the alias.
+     * @param options.addAlias Flag to add the document id as an alias to the aig vertex, defaults to true.
+     * @param options.aliasAnnotationObject Annotation object for the alias.
      * @param userIdentity The identity to perform the auditable item graph operation with.
      * @param nodeIdentity The node identity to use for vault operations.
-     * @returns The identifier for the document which includes the auditable item graph identifier.
+     * @returns The auditable item graph vertex created for the document including its revision.
      */
-    set(auditableItemGraphId: string, documentId: string, documentIdFormat: string | undefined, documentCode: UneceDocumentCodes, blob: Uint8Array, annotationObject?: IJsonLdNodeObject, options?: {
+    create(documentId: string, documentIdFormat: string | undefined, documentCode: UneceDocumentCodes, blob: Uint8Array, annotationObject?: IJsonLdNodeObject, auditableItemGraphEdges?: {
+        id: string;
+        addAlias?: boolean;
+        aliasAnnotationObject?: IJsonLdNodeObject;
+    }[], options?: {
         createAttestation?: boolean;
-        includeIdAsAlias?: boolean;
+        addAlias?: boolean;
         aliasAnnotationObject?: IJsonLdNodeObject;
     }, userIdentity?: string, nodeIdentity?: string): Promise<string>;
     /**
-     * Get a specific document from an auditable item graph vertex.
-     * @param auditableItemGraphId The auditable item graph vertex id to get the document from.
-     * @param identifier The identifier of the document to get.
+     * Update a document as an auditable item graph vertex and add its content to blob storage.
+     * If the blob data is different a new revision will be created.
+     * For any other changes the current revision will be updated.
+     * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
+     * @param blob The data to update the document with.
+     * @param annotationObject Additional information to associate with the document.
+     * @param auditableItemGraphEdges The auditable item graph vertices to connect the document to, if undefined retains current connections.
+     * @param userIdentity The identity to perform the auditable item graph operation with.
+     * @param nodeIdentity The node identity to use for vault operations.
+     * @returns Nothing.
+     */
+    update(auditableItemGraphDocumentId: string, blob?: Uint8Array, annotationObject?: IJsonLdNodeObject, auditableItemGraphEdges?: {
+        id: string;
+        addAlias?: boolean;
+        aliasAnnotationObject?: IJsonLdNodeObject;
+    }[], userIdentity?: string, nodeIdentity?: string): Promise<void>;
+    /**
+     * Get a document using it's auditable item graph vertex id and optional revision.
+     * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
      * @param options Additional options for the get operation.
      * @param options.includeBlobStorageMetadata Flag to include the blob storage metadata for the document, defaults to false.
      * @param options.includeBlobStorageData Flag to include the blob storage data for the document, defaults to false.
      * @param options.includeAttestation Flag to include the attestation information for the document, defaults to false.
      * @param options.includeRemoved Flag to include deleted documents, defaults to false.
-     * @param options.maxRevisionCount Max number of revisions to return, defaults to 0.
-     * @param revisionCursor The cursor to get the next chunk of revisions.
+     * @param options.extractRuleGroupId If provided will extract data from the document using the specified rule group id.
+     * @param options.extractMimeType By default extraction will auto detect the mime type of the document, this can be used to override the detection.
+     * @param cursor The cursor to get the next chunk of revisions.
+     * @param pageSize Page size of items to return, defaults to 1 so only most recent is returned.
      * @param userIdentity The identity to perform the auditable item graph operation with.
      * @param nodeIdentity The node identity to use for vault operations.
      * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
      */
-    get(auditableItemGraphId: string, identifier: string, options?: {
+    get(auditableItemGraphDocumentId: string, options?: {
         includeBlobStorageMetadata?: boolean;
         includeBlobStorageData?: boolean;
         includeAttestation?: boolean;
         includeRemoved?: boolean;
-        maxRevisionCount?: number;
-    }, revisionCursor?: string, userIdentity?: string, nodeIdentity?: string): Promise<IDocument>;
+        extractRuleGroupId?: string;
+        extractMimeType?: string;
+    }, cursor?: string, pageSize?: number, userIdentity?: string, nodeIdentity?: string): Promise<IDocumentList>;
     /**
-     * Remove a specific document from an auditable item graph vertex.
-     * The documents dateDeleted will be set, but can still be queried with the includeRemoved flag.
-     * @param auditableItemGraphId The auditable item graph vertex id to remove the document from.
-     * @param identifier The identifier of the document to remove.
-     * @param options Additional options for the remove operation.
-     * @param options.removeAllRevisions Flag to remove all revisions of the document, defaults to false.
+     * Get a document revision using it's auditable item graph vertex id.
+     * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
+     * @param revision The revision id of the document to get.
+     * @param options Additional options for the get operation.
+     * @param options.includeBlobStorageMetadata Flag to include the blob storage metadata for the document, defaults to false.
+     * @param options.includeBlobStorageData Flag to include the blob storage data for the document, defaults to false.
+     * @param options.includeAttestation Flag to include the attestation information for the document, defaults to false.
+     * @param options.extractRuleGroupId If provided will extract data from the document using the specified rule group id.
+     * @param options.extractMimeType By default extraction will auto detect the mime type of the document, this can be used to override the detection.
+     * @param userIdentity The identity to perform the auditable item graph operation with.
+     * @param nodeIdentity The node identity to use for vault operations.
+     * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
+     */
+    getRevision(auditableItemGraphDocumentId: string, revision: number, options?: {
+        includeBlobStorageMetadata?: boolean;
+        includeBlobStorageData?: boolean;
+        includeAttestation?: boolean;
+        extractRuleGroupId?: string;
+        extractMimeType?: string;
+    }, userIdentity?: string, nodeIdentity?: string): Promise<IDocument>;
+    /**
+     * Remove an auditable item graph vertex using it's id.
+     * The document dateDeleted will be set, but can still be queried with the includeRemoved flag.
+     * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
+     * @param revision The revision of the document to remove.
      * @param userIdentity The identity to perform the auditable item graph operation with.
      * @param nodeIdentity The node identity to use for vault operations.
      * @returns Nothing.
      */
-    remove(auditableItemGraphId: string, identifier: string, options?: {
-        removeAllRevisions?: boolean;
-    }, userIdentity?: string, nodeIdentity?: string): Promise<void>;
+    removeRevision(auditableItemGraphDocumentId: string, revision: number, userIdentity?: string, nodeIdentity?: string): Promise<void>;
     /**
-     * Query an auditable item graph vertex for documents.
-     * @param auditableItemGraphId The auditable item graph vertex to get the documents from.
-     * @param documentCodes The document codes to query for, if undefined gets all document codes.
-     * @param options Additional options for the query operation.
-     * @param options.includeMostRecentRevisions Include the most recent 5 revisions, use the individual get to retrieve more.
-     * @param options.includeRemoved Flag to include deleted documents, defaults to false.
+     * Find all the document with a specific id.
+     * @param documentId The document id to find in the graph.
      * @param cursor The cursor to get the next chunk of documents.
+     * @param pageSize The page size to get the next chunk of documents.
      * @param userIdentity The identity to perform the auditable item graph operation with.
      * @param nodeIdentity The node identity to use for vault operations.
-     * @returns The most recent revisions of each document, cursor is set if there are more documents.
+     * @returns The graph vertices that contain documents referencing the specified document id.
      */
-    query(auditableItemGraphId: string, documentCodes?: UneceDocumentCodes[], options?: {
-        includeMostRecentRevisions?: boolean;
-        includeRemoved?: boolean;
-    }, cursor?: string, userIdentity?: string, nodeIdentity?: string): Promise<IDocumentList>;
+    query(documentId: string, cursor?: string, pageSize?: number, userIdentity?: string, nodeIdentity?: string): Promise<IAuditableItemGraphVertexList>;
 }

package/dist/types/models/api/{IDocumentManagementSetRequest.d.ts → IDocumentManagementCreateRequest.d.ts}

@@ -1,18 +1,9 @@
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { UneceDocumentCodes } from "@twin.org/standards-unece";
 /**
- * Request to set a document in an auditable item graph vertex.
+ * Request to create a document as an auditable item graph vertex.
  */
-export interface IDocumentManagementSetRequest {
-    /**
-     * The path parameters.
-     */
-    pathParams: {
-        /**
-         * The id of the auditable item graph vertex to store the document on.
-         */
-        auditableItemGraphId: string;
-    };
+export interface IDocumentManagementCreateRequest {
     /**
      * The body parameters.
      */
@@ -38,15 +29,23 @@ export interface IDocumentManagementSetRequest {
          */
         annotationObject?: IJsonLdNodeObject;
         /**
-         * Flag to create an attestation for the document, defaults to false
+         * The auditable item graph vertices to connect the document to.
+         */
+        auditableItemGraphEdges?: {
+            id: string;
+            addAlias?: boolean;
+            aliasAnnotationObject?: IJsonLdNodeObject;
+        }[];
+        /**
+         * Flag to create an attestation for the document, defaults to false.
          */
         createAttestation?: boolean;
         /**
-         * Include the document id as an alias to the aig vertex, defaults to false.
+         * Flag to add the document id as an alias to the aig vertex, defaults to true.
          */
-        includeIdAsAlias?: boolean;
+        addAlias?: boolean;
         /**
-         * Additional information to associate with the alias.
+         * Annotation object for the alias.
          */
         aliasAnnotationObject?: IJsonLdNodeObject;
     };