@twin.org/document-management-service 0.0.2-next.3 → 0.0.3-next.1

package/dist/es/documentManagementService.js

@@ -0,0 +1,622 @@
+import { AttestationContexts } from "@twin.org/attestation-models";
+import { AuditableItemGraphContexts, AuditableItemGraphTypes } from "@twin.org/auditable-item-graph-models";
+import { BlobStorageContexts } from "@twin.org/blob-storage-models";
+import { ContextIdKeys, ContextIdStore } from "@twin.org/context";
+import { BaseError, Coerce, ComponentFactory, Converter, GeneralError, Guards, Is, NotFoundError, ObjectHelper, Urn } from "@twin.org/core";
+import { Sha256 } from "@twin.org/crypto";
+import { JsonLdProcessor } from "@twin.org/data-json-ld";
+import { DocumentContexts, DocumentTypes } from "@twin.org/document-management-models";
+import { SchemaOrgContexts, SchemaOrgDataTypes, SchemaOrgTypes } from "@twin.org/standards-schema-org";
+import { UneceDocumentCodes } from "@twin.org/standards-unece";
+/**
+ * Service for performing document management operations.
+ */
+export class DocumentManagementService {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "DocumentManagementService";
+    /**
+     * The component for the auditable item graph.
+     * @internal
+     */
+    _auditableItemGraphComponent;
+    /**
+     * The connector for the blob component.
+     * @internal
+     */
+    _blobStorageComponent;
+    /**
+     * The connector for the attestation.
+     * @internal
+     */
+    _attestationComponent;
+    /**
+     * The connector for the data processing.
+     * @internal
+     */
+    _dataProcessingComponent;
+    /**
+     * Create a new instance of DocumentManagementService.
+     * @param options The options for the service.
+     */
+    constructor(options) {
+        this._auditableItemGraphComponent = ComponentFactory.get(options?.auditableItemGraphComponentType ?? "auditable-item-graph");
+        this._blobStorageComponent = ComponentFactory.get(options?.blobStorageComponentType ?? "blob-storage");
+        this._attestationComponent = ComponentFactory.get(options?.attestationComponentType ?? "attestation");
+        this._dataProcessingComponent = ComponentFactory.get(options?.dataProcessingComponentType ?? "data-processing");
+        SchemaOrgDataTypes.registerRedirects();
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return DocumentManagementService.CLASS_NAME;
+    }
+    /**
+     * Store 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 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.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.
+     * @returns The auditable item graph vertex created for the document including its revision.
+     */
+    async create(documentId, documentIdFormat, documentCode, blob, annotationObject, auditableItemGraphEdges, options) {
+        Guards.stringValue(DocumentManagementService.CLASS_NAME, "documentId", documentId);
+        Guards.arrayOneOf(DocumentManagementService.CLASS_NAME, "documentCode", documentCode, Object.values(UneceDocumentCodes));
+        Guards.uint8Array(DocumentManagementService.CLASS_NAME, "blob", blob);
+        const contextIds = await ContextIdStore.getContextIds();
+        try {
+            // Get the connected vertices first, if one fails we abort the create
+            const connectedVertices = {};
+            if (Is.arrayValue(auditableItemGraphEdges)) {
+                for (const edge of auditableItemGraphEdges) {
+                    connectedVertices[edge.targetId] = await this._auditableItemGraphComponent.get(edge.targetId);
+                }
+            }
+            const documentVertex = {};
+            if (options?.addAlias ?? true) {
+                documentVertex.aliases ??= [];
+                documentVertex.aliases.push({
+                    "@context": AuditableItemGraphContexts.ContextRoot,
+                    type: AuditableItemGraphTypes.Alias,
+                    id: documentId,
+                    aliasFormat: documentIdFormat,
+                    annotationObject: options?.aliasAnnotationObject
+                });
+            }
+            // Add the blob to blob storage
+            const blobStorageId = await this._blobStorageComponent.create(Converter.bytesToBase64(blob));
+            const currentRevision = {
+                "@context": [
+                    DocumentContexts.ContextRoot,
+                    DocumentContexts.ContextRootCommon,
+                    SchemaOrgContexts.ContextRoot
+                ],
+                type: DocumentTypes.Document,
+                id: this.createDocumentId(documentId, 0),
+                documentId,
+                documentIdFormat,
+                documentCode,
+                documentRevision: 0,
+                annotationObject,
+                blobHash: this.generateBlobHash(blob),
+                blobStorageId,
+                dateCreated: new Date(Date.now()).toISOString(),
+                organizationIdentity: contextIds?.[ContextIdKeys.Organization],
+                userIdentity: contextIds?.[ContextIdKeys.User]
+            };
+            if (options?.createAttestation ?? false) {
+                currentRevision.attestationId = await this.createAttestation(currentRevision);
+            }
+            // Add the new revision in to the vertex
+            documentVertex.resources ??= [];
+            documentVertex.resources.push({
+                "@context": AuditableItemGraphContexts.ContextRoot,
+                type: AuditableItemGraphTypes.Resource,
+                resourceObject: currentRevision
+            });
+            // Add the edges from the document to the items
+            this.updateEdges(documentVertex, auditableItemGraphEdges);
+            // And create the vertex
+            const vertexId = await this._auditableItemGraphComponent.create(documentVertex);
+            // Now add the edges to the connected vertices
+            await this.updateConnectedEdges(connectedVertices, vertexId, [], auditableItemGraphEdges, documentId, documentIdFormat);
+            return vertexId;
+        }
+        catch (error) {
+            if (BaseError.someErrorName(error, "NotFoundError")) {
+                throw error;
+            }
+            throw new GeneralError(DocumentManagementService.CLASS_NAME, "createFailed", undefined, error);
+        }
+    }
+    /**
+     * 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.
+     * @returns Nothing.
+     */
+    async update(auditableItemGraphDocumentId, blob, annotationObject, auditableItemGraphEdges) {
+        Urn.guard(DocumentManagementService.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
+        try {
+            const documentVertex = await this._auditableItemGraphComponent.get(auditableItemGraphDocumentId, { includeDeleted: true });
+            if (Is.empty(documentVertex.resources)) {
+                throw new NotFoundError(DocumentManagementService.CLASS_NAME, "documentRevisionNone");
+            }
+            const documents = await this.getDocumentsFromVertex(documentVertex);
+            const latestRevision = documents.itemListElement[0];
+            documentVertex.resources = documentVertex.resources.filter(r => Is.empty(r.dateDeleted));
+            if (Is.empty(latestRevision)) {
+                throw new NotFoundError(DocumentManagementService.CLASS_NAME, "documentRevisionNone");
+            }
+            // If auditableItemGraphEdges is undefined we are not updating the edges
+            // an empty array can be passed to remove all edges
+            const connectedVertices = {};
+            if (Is.array(auditableItemGraphEdges)) {
+                // Get the updated connected vertices first, if one fails we abort the update
+                for (const edge of auditableItemGraphEdges) {
+                    connectedVertices[edge.targetId] = await this._auditableItemGraphComponent.get(edge.targetId);
+                }
+                // Also get the current edges in case some need disconnecting
+                if (Is.arrayValue(documents.edges)) {
+                    for (const edgeId of documents.edges) {
+                        // If we haven't retrieved the edge then it must be one that needs removing
+                        if (Is.empty(connectedVertices[edgeId])) {
+                            connectedVertices[edgeId] = await this._auditableItemGraphComponent.get(edgeId);
+                        }
+                    }
+                }
+            }
+            let updatedVertex = false;
+            // If the blob is set and its hash has changed then we create a new revision
+            if (Is.uint8Array(blob)) {
+                const newBlobHash = this.generateBlobHash(blob);
+                if (latestRevision.blobHash !== newBlobHash) {
+                    // Add the blob to blob storage
+                    const blobStorageId = await this._blobStorageComponent.create(Converter.bytesToBase64(blob));
+                    const newRevision = ObjectHelper.clone(latestRevision);
+                    newRevision.documentRevision++;
+                    newRevision.id = this.createDocumentId(newRevision.documentId, newRevision.documentRevision);
+                    newRevision.blobHash = newBlobHash;
+                    newRevision.blobStorageId = blobStorageId;
+                    newRevision.annotationObject = annotationObject;
+                    if (Is.stringValue(latestRevision.attestationId)) {
+                        newRevision.attestationId = await this.createAttestation(newRevision);
+                    }
+                    documentVertex.resources.push({
+                        "@context": AuditableItemGraphContexts.ContextRoot,
+                        type: AuditableItemGraphTypes.Resource,
+                        resourceObject: newRevision
+                    });
+                    updatedVertex = true;
+                }
+            }
+            // If the blob wasn't updated but the annotation object has then update the current revision
+            // instead of creating a new one
+            if (!updatedVertex &&
+                !ObjectHelper.equal(latestRevision.annotationObject, annotationObject)) {
+                updatedVertex = true;
+                latestRevision.annotationObject = annotationObject;
+                latestRevision.dateModified = new Date(Date.now()).toISOString();
+            }
+            const existingEdgeIds = documentVertex.edges?.map(e => e.targetId) ?? [];
+            // Update the edges from the document to the items
+            const edgesUpdated = this.updateEdges(documentVertex, auditableItemGraphEdges);
+            if (edgesUpdated) {
+                updatedVertex = true;
+            }
+            if (updatedVertex) {
+                await this._auditableItemGraphComponent.update(documentVertex);
+            }
+            if (edgesUpdated) {
+                await this.updateConnectedEdges(connectedVertices, auditableItemGraphDocumentId, existingEdgeIds, auditableItemGraphEdges, latestRevision.documentId, latestRevision.documentIdFormat);
+            }
+        }
+        catch (error) {
+            if (BaseError.someErrorName(error, "NotFoundError")) {
+                throw error;
+            }
+            throw new GeneralError(DocumentManagementService.CLASS_NAME, "updateFailed", undefined, error);
+        }
+    }
+    /**
+     * 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.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 limit Limit the number of items to return, defaults to 1 so only most recent is returned.
+     * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
+     */
+    async get(auditableItemGraphDocumentId, options, cursor, limit) {
+        Urn.guard(DocumentManagementService.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
+        try {
+            const documentVertex = await this._auditableItemGraphComponent.get(auditableItemGraphDocumentId, { includeDeleted: options?.includeRemoved });
+            // Populate the document and revisions with the options set
+            const documents = await this.getDocumentsFromVertex(documentVertex, options, cursor, limit);
+            const result = await JsonLdProcessor.compact(documents, documents["@context"]);
+            return result;
+        }
+        catch (error) {
+            if (BaseError.someErrorName(error, "NotFoundError")) {
+                throw error;
+            }
+            throw new GeneralError(DocumentManagementService.CLASS_NAME, "getFailed", undefined, error);
+        }
+    }
+    /**
+     * 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 for 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.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.
+     * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
+     */
+    async getRevision(auditableItemGraphDocumentId, revision, options) {
+        Urn.guard(DocumentManagementService.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
+        Guards.integer(DocumentManagementService.CLASS_NAME, "revision", revision);
+        try {
+            const documentVertex = await this._auditableItemGraphComponent.get(auditableItemGraphDocumentId, { includeDeleted: true });
+            if (Is.empty(documentVertex.resources)) {
+                throw new NotFoundError(DocumentManagementService.CLASS_NAME, "documentRevisionNone");
+            }
+            documentVertex.resources = documentVertex.resources.filter(d => d.resourceObject?.documentRevision === revision);
+            if (documentVertex.resources.length === 0) {
+                throw new NotFoundError(DocumentManagementService.CLASS_NAME, "documentRevisionNotFound", revision.toString());
+            }
+            // Populate the document and revisions with the options set
+            const docList = await this.getDocumentsFromVertex(documentVertex, options);
+            const result = await JsonLdProcessor.compact(docList.itemListElement[0], docList.itemListElement[0]["@context"]);
+            return result;
+        }
+        catch (error) {
+            if (BaseError.someErrorName(error, "NotFoundError")) {
+                throw error;
+            }
+            throw new GeneralError(DocumentManagementService.CLASS_NAME, "getRevisionFailed", undefined, error);
+        }
+    }
+    /**
+     * 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.
+     * @returns Nothing.
+     */
+    async removeRevision(auditableItemGraphDocumentId, revision) {
+        Urn.guard(DocumentManagementService.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
+        Guards.number(DocumentManagementService.CLASS_NAME, "revision", revision);
+        try {
+            const documentVertex = await this._auditableItemGraphComponent.get(auditableItemGraphDocumentId);
+            if (Is.empty(documentVertex.resources)) {
+                throw new NotFoundError(DocumentManagementService.CLASS_NAME, "documentRevisionNone");
+            }
+            const docRevisionIndex = documentVertex.resources.findIndex(d => d.resourceObject?.documentRevision === revision);
+            if (docRevisionIndex === -1) {
+                throw new NotFoundError(DocumentManagementService.CLASS_NAME, "documentRevisionNotFound", revision.toString());
+            }
+            documentVertex.resources.splice(docRevisionIndex, 1);
+            await this._auditableItemGraphComponent.update(documentVertex);
+        }
+        catch (error) {
+            if (BaseError.someErrorName(error, "NotFoundError")) {
+                throw error;
+            }
+            throw new GeneralError(DocumentManagementService.CLASS_NAME, "removeRevisionFailed", undefined, error);
+        }
+    }
+    /**
+     * 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 limit The limit to get the next chunk of documents.
+     * @returns The graph vertices that contain documents referencing the specified document id.
+     */
+    async query(documentId, cursor, limit) {
+        Guards.stringValue(DocumentManagementService.CLASS_NAME, "documentId", documentId);
+        try {
+            const result = await this._auditableItemGraphComponent.query({
+                id: documentId,
+                idMode: "both",
+                resourceTypes: [DocumentTypes.Document]
+            }, undefined, undefined, undefined, ["id", "dateCreated", "dateModified", "aliases", "annotationObject", "resources", "edges"], cursor, limit);
+            return result;
+        }
+        catch (error) {
+            if (BaseError.someErrorName(error, "NotFoundError")) {
+                throw error;
+            }
+            throw new GeneralError(DocumentManagementService.CLASS_NAME, "queryFailed", undefined, error);
+        }
+    }
+    /**
+     * Update the edges of the document vertex.
+     * @param documentVertex The document vertex to update.
+     * @param auditableItemGraphEdges The list of edges to use.
+     * @returns True if the edges were updated.
+     * @internal
+     */
+    updateEdges(documentVertex, auditableItemGraphEdges) {
+        let changed = false;
+        const existingEdgeIds = documentVertex.edges?.map(e => e.targetId) ?? [];
+        if (Is.array(auditableItemGraphEdges)) {
+            for (const aigEdge of auditableItemGraphEdges) {
+                const existingIndex = existingEdgeIds.indexOf(aigEdge.targetId);
+                if (existingIndex !== -1) {
+                    // If the edge already exists then we don't need to add it again
+                    // We just need to remove it from the list of existing ids
+                    // any remaining after this loop will be need to be removed
+                    existingEdgeIds.splice(existingIndex, 1);
+                }
+                else {
+                    const vertexEdge = {
+                        "@context": AuditableItemGraphContexts.ContextRoot,
+                        type: AuditableItemGraphTypes.Edge,
+                        targetId: aigEdge.targetId,
+                        edgeRelationships: ["document"]
+                    };
+                    documentVertex.edges ??= [];
+                    documentVertex.edges?.push(vertexEdge);
+                    changed = true;
+                }
+            }
+            // Anything left in the existingEdgeIds array means they need to be removed
+            if (existingEdgeIds.length > 0 && Is.array(documentVertex.edges)) {
+                for (const existingEdgeId of existingEdgeIds) {
+                    const existingIndex = documentVertex.edges.findIndex(e => e.targetId === existingEdgeId);
+                    if (existingIndex !== -1) {
+                        documentVertex.edges.splice(existingIndex, 1);
+                        changed = true;
+                    }
+                }
+            }
+        }
+        return changed;
+    }
+    /**
+     * Update the edges.
+     * @param connectedVertices The connected vertices for the edges.
+     * @param auditableItemGraphDocumentId The document id to use.
+     * @param documentVertex The document vertex to update.
+     * @param auditableItemGraphEdges The list of edges to use.
+     * @param documentId The document identifier.
+     * @param documentIdFormat The format of the document identifier.
+     * @internal
+     */
+    async updateConnectedEdges(connectedVertices, auditableItemGraphDocumentId, existingEdgeIds, auditableItemGraphEdges, documentId, documentIdFormat) {
+        if (Is.array(auditableItemGraphEdges)) {
+            for (const aigEdge of auditableItemGraphEdges) {
+                const connected = connectedVertices[aigEdge.targetId];
+                if (!Is.empty(connected)) {
+                    let updatedConnected = false;
+                    const existingIndex = existingEdgeIds.indexOf(aigEdge.targetId);
+                    if (existingIndex !== -1) {
+                        // If the edge already exists we remove it from the list of existing ids
+                        // any remaining after this loop will be need to be disconnected
+                        existingEdgeIds.splice(existingIndex, 1);
+                    }
+                    // Add the edge with the document vertex id if it doesn't already exist
+                    const hasEdge = connected.edges?.some(e => e.targetId === auditableItemGraphDocumentId);
+                    if (!hasEdge) {
+                        const vertexEdge = {
+                            "@context": AuditableItemGraphContexts.ContextRoot,
+                            type: AuditableItemGraphTypes.Edge,
+                            targetId: auditableItemGraphDocumentId,
+                            edgeRelationships: ["document"]
+                        };
+                        connected.edges ??= [];
+                        connected.edges?.push(vertexEdge);
+                        updatedConnected = true;
+                    }
+                    // Add alias with the document id if option flag is set and it doesn't already exist
+                    if (aigEdge.addAlias) {
+                        const alias = connected.aliases?.find(a => a.id === documentId);
+                        if (Is.empty(alias)) {
+                            // No existing alias, so create one
+                            const vertexAlias = {
+                                "@context": AuditableItemGraphContexts.ContextRoot,
+                                type: AuditableItemGraphTypes.Alias,
+                                id: documentId,
+                                aliasFormat: documentIdFormat,
+                                annotationObject: aigEdge.aliasAnnotationObject
+                            };
+                            connected.aliases ??= [];
+                            connected.aliases?.push(vertexAlias);
+                            updatedConnected = true;
+                        }
+                        else if (!ObjectHelper.equal(alias.annotationObject, aigEdge.aliasAnnotationObject) ||
+                            documentIdFormat !== alias.aliasFormat) {
+                            // The alias already exists, but the format or annotation object has changed
+                            alias.annotationObject = aigEdge.aliasAnnotationObject;
+                            alias.aliasFormat = documentIdFormat;
+                            updatedConnected = true;
+                        }
+                    }
+                    if (updatedConnected) {
+                        await this._auditableItemGraphComponent.update(connected);
+                    }
+                }
+            }
+        }
+        // Anything left in the existingEdgeIds array means they need to be removed
+        if (existingEdgeIds.length > 0) {
+            for (const existingEdgeId of existingEdgeIds) {
+                const connected = connectedVertices[existingEdgeId];
+                if (!Is.empty(connected)) {
+                    let updatedConnected = false;
+                    // Remove the edge from the connected vertex
+                    if (Is.arrayValue(connected.edges)) {
+                        const existingIndex = connected.edges.findIndex(e => e.targetId === auditableItemGraphDocumentId);
+                        if (existingIndex !== -1) {
+                            connected.edges.splice(existingIndex, 1);
+                            updatedConnected = true;
+                        }
+                    }
+                    // Remove the alias from the connected vertex
+                    if (Is.arrayValue(connected.aliases)) {
+                        const existingIndex = connected.aliases.findIndex(e => e.id === documentId);
+                        if (existingIndex !== -1) {
+                            connected.aliases.splice(existingIndex, 1);
+                            updatedConnected = true;
+                        }
+                    }
+                    if (updatedConnected) {
+                        await this._auditableItemGraphComponent.update(connected);
+                    }
+                }
+            }
+        }
+    }
+    /**
+     * Generate a hash for the blob data.
+     * @param blob The blob data to hash.
+     * @returns The hash.
+     * @internal
+     */
+    generateBlobHash(blob) {
+        return `sha256:${Converter.bytesToBase64(Sha256.sum256(blob))}`;
+    }
+    /**
+     * Get the documents from the auditable item graph vertex.
+     * @param documentVertex The vertex containing the documents.
+     * @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 cursor The cursor to get the next chunk of revisions.
+     * @param limit Limit the number of items to return, defaults to 1 so only most recent is returned.
+     * @returns The finalised list of documents.
+     * @internal
+     */
+    async getDocumentsFromVertex(documentVertex, options, cursor, limit) {
+        const docList = {
+            "@context": [
+                SchemaOrgContexts.ContextRoot,
+                DocumentContexts.ContextRoot,
+                DocumentContexts.ContextRootCommon
+            ],
+            type: SchemaOrgTypes.ItemList,
+            [SchemaOrgTypes.ItemListElement]: []
+        };
+        if (Is.arrayValue(documentVertex.resources)) {
+            // Sort by newest revision first
+            documentVertex.resources.sort((a, b) => (Coerce.number(b.resourceObject?.documentRevision) ?? 0) -
+                (Coerce.number(a.resourceObject?.documentRevision) ?? 0));
+            const startIndex = Coerce.integer(cursor) ?? 0;
+            const endIndex = Math.min(startIndex + (limit ?? 1), documentVertex.resources.length);
+            const slicedResources = documentVertex.resources.slice(startIndex, endIndex);
+            docList[SchemaOrgTypes.NextItem] =
+                documentVertex.resources.length > endIndex ? (endIndex + 1).toString() : undefined;
+            const includeBlobStorageMetadata = options?.includeBlobStorageMetadata ?? false;
+            const includeBlobStorageData = options?.includeBlobStorageData ?? false;
+            const includeAttestation = options?.includeAttestation ?? false;
+            const extractData = Is.stringValue(options?.extractRuleGroupId);
+            for (let i = 0; i < slicedResources.length; i++) {
+                const document = slicedResources[i].resourceObject;
+                if (Is.object(document)) {
+                    document.dateDeleted = slicedResources[i].dateDeleted;
+                    docList[SchemaOrgTypes.ItemListElement].push(document);
+                    const blobRequired = includeBlobStorageMetadata || includeBlobStorageData;
+                    if (blobRequired || extractData) {
+                        const blobEntry = await this._blobStorageComponent.get(document.blobStorageId, {
+                            includeContent: includeBlobStorageData || extractData
+                        });
+                        if (blobRequired) {
+                            document.blobStorageEntry = blobEntry;
+                            if (!docList["@context"].includes(BlobStorageContexts.ContextRoot)) {
+                                docList["@context"].push(BlobStorageContexts.ContextRoot);
+                            }
+                        }
+                        if (Is.stringValue(options?.extractRuleGroupId) && Is.stringValue(blobEntry.blob)) {
+                            const binaryBlob = Converter.base64ToBytes(blobEntry.blob);
+                            document.extractedData = await this._dataProcessingComponent.extract(options.extractRuleGroupId, binaryBlob, undefined, options?.extractMimeType);
+                        }
+                        // If we have the blob data due to extraction but we weren't asked for it
+                        // then we remove it from the document
+                        if (!blobRequired) {
+                            delete document.blobStorageEntry;
+                        }
+                        else if (!includeBlobStorageData) {
+                            delete document.blobStorageEntry?.blob;
+                        }
+                    }
+                    if (includeAttestation && Is.stringValue(document.attestationId)) {
+                        const attestationInformation = await this._attestationComponent.get(document.attestationId);
+                        document.attestationInformation = attestationInformation;
+                        if (!docList["@context"].includes(AttestationContexts.ContextRoot)) {
+                            docList["@context"].push(AttestationContexts.ContextRoot);
+                        }
+                    }
+                }
+            }
+        }
+        if (Is.arrayValue(documentVertex.edges)) {
+            docList.edges ??= [];
+            for (const edge of documentVertex.edges) {
+                if (Is.object(edge)) {
+                    docList.edges.push(edge.targetId);
+                }
+            }
+        }
+        return docList;
+    }
+    /**
+     * Create an attestation for the document.
+     * @param document The document to create the attestation for.
+     * @returns The attestation identifier.
+     */
+    async createAttestation(document) {
+        const documentAttestation = {
+            "@context": [
+                DocumentContexts.ContextRoot,
+                DocumentContexts.ContextRootCommon,
+                SchemaOrgContexts.ContextRoot
+            ],
+            type: DocumentTypes.DocumentAttestation,
+            id: document.id,
+            documentId: document.documentId,
+            documentCode: document.documentCode,
+            documentRevision: document.documentRevision,
+            dateCreated: document.dateCreated,
+            blobHash: document.blobHash
+        };
+        return this._attestationComponent.create(documentAttestation);
+    }
+    /**
+     * Create a document id from the document id and revision.
+     * @param documentId The document id to create.
+     * @param revision The revision of the document.
+     * @returns The document id.
+     * @internal
+     */
+    createDocumentId(documentId, revision) {
+        const documentIdHash = Converter.bytesToBase64Url(Sha256.sum256(Converter.utf8ToBytes(documentId)));
+        return `document:${documentIdHash}:${revision}`;
+    }
+}
+//# sourceMappingURL=documentManagementService.js.map