@twin.org/document-management-service 0.0.1-next.11 → 0.0.1-next.13

package/dist/cjs/index.cjs

@@ -224,7 +224,101 @@ function generateRestRoutesDocumentManagement(baseRouteName, componentName) {
             }
         ]
     };
-    const documentManagementRemoveRoute = {
+    const documentManagementGetRevisionRoute = {
+        operationId: "DocumentManagementGetRevision",
+        summary: "Get the data for a document revision from document management",
+        tag: tagsDocumentManagement[0].name,
+        method: "GET",
+        path: `${baseRouteName}/:auditableItemGraphDocumentId/:revision`,
+        handler: async (httpRequestContext, request) => documentManagementGetRevision(httpRequestContext, componentName, request),
+        requestType: {
+            type: "IDocumentManagementGetRequest",
+            examples: [
+                {
+                    id: "DocumentManagementGetRevisionRequestExample",
+                    request: {
+                        pathParams: {
+                            auditableItemGraphDocumentId: "aig:123456",
+                            revision: "1"
+                        }
+                    }
+                }
+            ]
+        },
+        responseType: [
+            {
+                type: "IDocumentManagementGetRevisionResponse",
+                examples: [
+                    {
+                        id: "DocumentManagementGetRevisionResponseExample",
+                        response: {
+                            body: {
+                                "@context": [
+                                    documentManagementModels.DocumentContexts.ContextRoot,
+                                    documentManagementModels.DocumentContexts.ContextRootCommon,
+                                    standardsSchemaOrg.SchemaOrgContexts.ContextRoot
+                                ],
+                                type: documentManagementModels.DocumentTypes.Document,
+                                id: "2721000:0",
+                                documentId: "2721000",
+                                documentIdFormat: "bol",
+                                documentCode: standardsUnece.UneceDocumentCodes.BillOfLading,
+                                documentRevision: 1,
+                                blobStorageId: "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
+                                blobHash: "sha256:123456",
+                                dateCreated: "2024-01-01T00:00:00Z",
+                                annotationObject: {
+                                    "@context": "https://schema.org",
+                                    "@type": "DigitalDocument",
+                                    name: "myfile.pdf"
+                                },
+                                nodeIdentity: "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+                                userIdentity: "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
+                            }
+                        }
+                    }
+                ]
+            },
+            {
+                type: "IDocumentManagementGetRevisionResponse",
+                mimeType: web.MimeTypes.JsonLd,
+                examples: [
+                    {
+                        id: "DocumentManagementGetRevisionResponseExample",
+                        response: {
+                            body: {
+                                "@context": [
+                                    documentManagementModels.DocumentContexts.ContextRoot,
+                                    documentManagementModels.DocumentContexts.ContextRootCommon,
+                                    standardsSchemaOrg.SchemaOrgContexts.ContextRoot
+                                ],
+                                type: documentManagementModels.DocumentTypes.Document,
+                                id: "2721000:0",
+                                documentId: "2721000",
+                                documentIdFormat: "bol",
+                                documentCode: standardsUnece.UneceDocumentCodes.BillOfLading,
+                                documentRevision: 1,
+                                blobStorageId: "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
+                                blobHash: "sha256:123456",
+                                dateCreated: "2024-01-01T00:00:00Z",
+                                annotationObject: {
+                                    "@context": "https://schema.org",
+                                    "@type": "DigitalDocument",
+                                    name: "myfile.pdf"
+                                },
+                                nodeIdentity: "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+                                userIdentity: "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
+                            }
+                        }
+                    }
+                ]
+            },
+            {
+                type: "INotFoundResponse"
+            }
+        ]
+    };
+    const documentManagementRemoveRevisionRoute = {
         operationId: "DocumentManagementRemove",
         summary: "Remove an document from an auditable item graph vertex",
         tag: tagsDocumentManagement[0].name,
@@ -343,7 +437,8 @@ function generateRestRoutesDocumentManagement(baseRouteName, componentName) {
         documentManagementCreateRoute,
         documentManagementUpdateRoute,
         documentManagementGetRoute,
-        documentManagementRemoveRoute,
+        documentManagementGetRevisionRoute,
+        documentManagementRemoveRevisionRoute,
         documentManagementQueryRoute
     ];
 }
@@ -388,7 +483,9 @@ async function documentManagementGet(httpRequestContext, componentName, request)
         includeBlobStorageMetadata: core.Coerce.boolean(request.query?.includeBlobStorageMetadata),
         includeBlobStorageData: core.Coerce.boolean(request.query?.includeBlobStorageData),
         includeAttestation: core.Coerce.boolean(request.query?.includeAttestation),
-        includeRemoved: core.Coerce.boolean(request.query?.includeRemoved)
+        includeRemoved: core.Coerce.boolean(request.query?.includeRemoved),
+        extractRuleGroupId: request.query?.extractRuleGroupId,
+        extractMimeType: request.query?.extractMimeType
     }, request.query?.cursor, core.Coerce.integer(request.query?.pageSize), httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
     return {
         headers: {
@@ -398,7 +495,36 @@ async function documentManagementGet(httpRequestContext, componentName, request)
     };
 }
 /**
- * UPdate the document from the auditable item graph vertex.
+ * Get the document revision from the auditable item graph vertex.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+async function documentManagementGetRevision(httpRequestContext, componentName, request) {
+    core.Guards.object(ROUTES_SOURCE, "request", request);
+    core.Guards.object(ROUTES_SOURCE, "request.pathParams", request.pathParams);
+    core.Guards.stringValue(ROUTES_SOURCE, "request.pathParams.auditableItemGraphDocumentId", request.pathParams.auditableItemGraphDocumentId);
+    const revision = core.Coerce.integer(request.pathParams.revision);
+    core.Guards.integer(ROUTES_SOURCE, "revision", revision);
+    const mimeType = request.headers?.[web.HeaderTypes.Accept] === web.MimeTypes.JsonLd ? "jsonld" : "json";
+    const component = core.ComponentFactory.get(componentName);
+    const result = await component.getRevision(request.pathParams.auditableItemGraphDocumentId, revision, {
+        includeBlobStorageMetadata: core.Coerce.boolean(request.query?.includeBlobStorageMetadata),
+        includeBlobStorageData: core.Coerce.boolean(request.query?.includeBlobStorageData),
+        includeAttestation: core.Coerce.boolean(request.query?.includeAttestation),
+        extractRuleGroupId: request.query?.extractRuleGroupId,
+        extractMimeType: request.query?.extractMimeType
+    }, httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
+    return {
+        headers: {
+            [web.HeaderTypes.ContentType]: mimeType === "json" ? web.MimeTypes.Json : web.MimeTypes.JsonLd
+        },
+        body: result
+    };
+}
+/**
+ * Update the document from the auditable item graph vertex.
  * @param httpRequestContext The request context for the API.
  * @param componentName The name of the component to use in the routes.
  * @param request The request.
@@ -550,7 +676,7 @@ class DocumentManagementService {
                     standardsSchemaOrg.SchemaOrgContexts.ContextRoot
                 ],
                 type: documentManagementModels.DocumentTypes.Document,
-                id: `${documentId}:0`,
+                id: this.createDocumentId(documentId, 0),
                 documentId,
                 documentIdFormat,
                 documentCode,
@@ -604,12 +730,13 @@ class DocumentManagementService {
         core.Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
         core.Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
         try {
-            const documentVertex = await this._auditableItemGraphComponent.get(auditableItemGraphDocumentId);
+            const documentVertex = await this._auditableItemGraphComponent.get(auditableItemGraphDocumentId, { includeDeleted: true });
             if (core.Is.empty(documentVertex.resources)) {
                 throw new core.NotFoundError(this.CLASS_NAME, "documentRevisionNone");
             }
             const documents = await this.getDocumentsFromVertex(documentVertex);
             const latestRevision = documents.documents[0];
+            documentVertex.resources = documentVertex.resources.filter(r => core.Is.empty(r.dateDeleted));
             if (core.Is.empty(latestRevision)) {
                 throw new core.NotFoundError(this.CLASS_NAME, "documentRevisionNone");
             }
@@ -640,7 +767,7 @@ class DocumentManagementService {
                     const blobStorageId = await this._blobStorageComponent.create(core.Converter.bytesToBase64(blob), undefined, undefined, undefined, undefined, userIdentity, nodeIdentity);
                     const newRevision = core.ObjectHelper.clone(latestRevision);
                     newRevision.documentRevision++;
-                    newRevision.id = `${newRevision.documentId}:${newRevision.documentRevision}`;
+                    newRevision.id = this.createDocumentId(newRevision.documentId, newRevision.documentRevision);
                     newRevision.blobHash = newBlobHash;
                     newRevision.blobStorageId = blobStorageId;
                     newRevision.annotationObject = annotationObject;
@@ -714,6 +841,43 @@ class DocumentManagementService {
             throw new core.GeneralError(this.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.
+     * @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.
+     */
+    async getRevision(auditableItemGraphDocumentId, revision, options, userIdentity, nodeIdentity) {
+        core.Urn.guard(this.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
+        core.Guards.integer(this.CLASS_NAME, "revision", revision);
+        try {
+            const documentVertex = await this._auditableItemGraphComponent.get(auditableItemGraphDocumentId, { includeDeleted: true });
+            if (core.Is.empty(documentVertex.resources)) {
+                throw new core.NotFoundError(this.CLASS_NAME, "documentRevisionNone");
+            }
+            documentVertex.resources = documentVertex.resources.filter(d => d.resourceObject?.documentRevision === revision);
+            if (documentVertex.resources.length === 0) {
+                throw new core.NotFoundError(this.CLASS_NAME, "documentRevisionNotFound", revision.toString());
+            }
+            // Populate the document and revisions with the options set
+            const docList = await this.getDocumentsFromVertex(documentVertex, options, undefined, undefined, userIdentity, nodeIdentity);
+            return dataJsonLd.JsonLdProcessor.compact(docList.documents[0], docList.documents[0]["@context"]);
+        }
+        catch (error) {
+            if (core.BaseError.someErrorName(error, "NotFoundError")) {
+                throw error;
+            }
+            throw new core.GeneralError(this.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.
@@ -961,6 +1125,7 @@ class DocumentManagementService {
             for (let i = 0; i < slicedResources.length; i++) {
                 const document = slicedResources[i].resourceObject;
                 if (core.Is.object(document)) {
+                    document.dateDeleted = slicedResources[i].dateDeleted;
                     docList.documents.push(document);
                     const blobRequired = includeBlobStorageMetadata || includeBlobStorageData;
                     if (blobRequired || extractData) {
@@ -1028,6 +1193,17 @@ class DocumentManagementService {
         };
         return this._attestationComponent.create(documentAttestation, undefined, userIdentity, nodeIdentity);
     }
+    /**
+     * 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 = core.Converter.bytesToBase64Url(crypto.Sha256.sum256(core.Converter.utf8ToBytes(documentId)));
+        return `document:${documentIdHash}:${revision}`;
+    }
 }
 
 const restEntryPoints = [
@@ -1042,6 +1218,7 @@ const restEntryPoints = [
 exports.DocumentManagementService = DocumentManagementService;
 exports.documentManagementCreate = documentManagementCreate;
 exports.documentManagementGet = documentManagementGet;
+exports.documentManagementGetRevision = documentManagementGetRevision;
 exports.documentManagementQuery = documentManagementQuery;
 exports.documentManagementRemove = documentManagementRemove;
 exports.documentManagementUpdate = documentManagementUpdate;

package/dist/esm/index.mjs

@@ -222,7 +222,101 @@ function generateRestRoutesDocumentManagement(baseRouteName, componentName) {
             }
         ]
     };
-    const documentManagementRemoveRoute = {
+    const documentManagementGetRevisionRoute = {
+        operationId: "DocumentManagementGetRevision",
+        summary: "Get the data for a document revision from document management",
+        tag: tagsDocumentManagement[0].name,
+        method: "GET",
+        path: `${baseRouteName}/:auditableItemGraphDocumentId/:revision`,
+        handler: async (httpRequestContext, request) => documentManagementGetRevision(httpRequestContext, componentName, request),
+        requestType: {
+            type: "IDocumentManagementGetRequest",
+            examples: [
+                {
+                    id: "DocumentManagementGetRevisionRequestExample",
+                    request: {
+                        pathParams: {
+                            auditableItemGraphDocumentId: "aig:123456",
+                            revision: "1"
+                        }
+                    }
+                }
+            ]
+        },
+        responseType: [
+            {
+                type: "IDocumentManagementGetRevisionResponse",
+                examples: [
+                    {
+                        id: "DocumentManagementGetRevisionResponseExample",
+                        response: {
+                            body: {
+                                "@context": [
+                                    DocumentContexts.ContextRoot,
+                                    DocumentContexts.ContextRootCommon,
+                                    SchemaOrgContexts.ContextRoot
+                                ],
+                                type: DocumentTypes.Document,
+                                id: "2721000:0",
+                                documentId: "2721000",
+                                documentIdFormat: "bol",
+                                documentCode: UneceDocumentCodes.BillOfLading,
+                                documentRevision: 1,
+                                blobStorageId: "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
+                                blobHash: "sha256:123456",
+                                dateCreated: "2024-01-01T00:00:00Z",
+                                annotationObject: {
+                                    "@context": "https://schema.org",
+                                    "@type": "DigitalDocument",
+                                    name: "myfile.pdf"
+                                },
+                                nodeIdentity: "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+                                userIdentity: "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
+                            }
+                        }
+                    }
+                ]
+            },
+            {
+                type: "IDocumentManagementGetRevisionResponse",
+                mimeType: MimeTypes.JsonLd,
+                examples: [
+                    {
+                        id: "DocumentManagementGetRevisionResponseExample",
+                        response: {
+                            body: {
+                                "@context": [
+                                    DocumentContexts.ContextRoot,
+                                    DocumentContexts.ContextRootCommon,
+                                    SchemaOrgContexts.ContextRoot
+                                ],
+                                type: DocumentTypes.Document,
+                                id: "2721000:0",
+                                documentId: "2721000",
+                                documentIdFormat: "bol",
+                                documentCode: UneceDocumentCodes.BillOfLading,
+                                documentRevision: 1,
+                                blobStorageId: "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
+                                blobHash: "sha256:123456",
+                                dateCreated: "2024-01-01T00:00:00Z",
+                                annotationObject: {
+                                    "@context": "https://schema.org",
+                                    "@type": "DigitalDocument",
+                                    name: "myfile.pdf"
+                                },
+                                nodeIdentity: "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+                                userIdentity: "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
+                            }
+                        }
+                    }
+                ]
+            },
+            {
+                type: "INotFoundResponse"
+            }
+        ]
+    };
+    const documentManagementRemoveRevisionRoute = {
         operationId: "DocumentManagementRemove",
         summary: "Remove an document from an auditable item graph vertex",
         tag: tagsDocumentManagement[0].name,
@@ -341,7 +435,8 @@ function generateRestRoutesDocumentManagement(baseRouteName, componentName) {
         documentManagementCreateRoute,
         documentManagementUpdateRoute,
         documentManagementGetRoute,
-        documentManagementRemoveRoute,
+        documentManagementGetRevisionRoute,
+        documentManagementRemoveRevisionRoute,
         documentManagementQueryRoute
     ];
 }
@@ -386,7 +481,9 @@ async function documentManagementGet(httpRequestContext, componentName, request)
         includeBlobStorageMetadata: Coerce.boolean(request.query?.includeBlobStorageMetadata),
         includeBlobStorageData: Coerce.boolean(request.query?.includeBlobStorageData),
         includeAttestation: Coerce.boolean(request.query?.includeAttestation),
-        includeRemoved: Coerce.boolean(request.query?.includeRemoved)
+        includeRemoved: Coerce.boolean(request.query?.includeRemoved),
+        extractRuleGroupId: request.query?.extractRuleGroupId,
+        extractMimeType: request.query?.extractMimeType
     }, request.query?.cursor, Coerce.integer(request.query?.pageSize), httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
     return {
         headers: {
@@ -396,7 +493,36 @@ async function documentManagementGet(httpRequestContext, componentName, request)
     };
 }
 /**
- * UPdate the document from the auditable item graph vertex.
+ * Get the document revision from the auditable item graph vertex.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+async function documentManagementGetRevision(httpRequestContext, componentName, request) {
+    Guards.object(ROUTES_SOURCE, "request", request);
+    Guards.object(ROUTES_SOURCE, "request.pathParams", request.pathParams);
+    Guards.stringValue(ROUTES_SOURCE, "request.pathParams.auditableItemGraphDocumentId", request.pathParams.auditableItemGraphDocumentId);
+    const revision = Coerce.integer(request.pathParams.revision);
+    Guards.integer(ROUTES_SOURCE, "revision", revision);
+    const mimeType = request.headers?.[HeaderTypes.Accept] === MimeTypes.JsonLd ? "jsonld" : "json";
+    const component = ComponentFactory.get(componentName);
+    const result = await component.getRevision(request.pathParams.auditableItemGraphDocumentId, revision, {
+        includeBlobStorageMetadata: Coerce.boolean(request.query?.includeBlobStorageMetadata),
+        includeBlobStorageData: Coerce.boolean(request.query?.includeBlobStorageData),
+        includeAttestation: Coerce.boolean(request.query?.includeAttestation),
+        extractRuleGroupId: request.query?.extractRuleGroupId,
+        extractMimeType: request.query?.extractMimeType
+    }, httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
+    return {
+        headers: {
+            [HeaderTypes.ContentType]: mimeType === "json" ? MimeTypes.Json : MimeTypes.JsonLd
+        },
+        body: result
+    };
+}
+/**
+ * Update the document from the auditable item graph vertex.
  * @param httpRequestContext The request context for the API.
  * @param componentName The name of the component to use in the routes.
  * @param request The request.
@@ -548,7 +674,7 @@ class DocumentManagementService {
                     SchemaOrgContexts.ContextRoot
                 ],
                 type: DocumentTypes.Document,
-                id: `${documentId}:0`,
+                id: this.createDocumentId(documentId, 0),
                 documentId,
                 documentIdFormat,
                 documentCode,
@@ -602,12 +728,13 @@ class DocumentManagementService {
         Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
         Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
         try {
-            const documentVertex = await this._auditableItemGraphComponent.get(auditableItemGraphDocumentId);
+            const documentVertex = await this._auditableItemGraphComponent.get(auditableItemGraphDocumentId, { includeDeleted: true });
             if (Is.empty(documentVertex.resources)) {
                 throw new NotFoundError(this.CLASS_NAME, "documentRevisionNone");
             }
             const documents = await this.getDocumentsFromVertex(documentVertex);
             const latestRevision = documents.documents[0];
+            documentVertex.resources = documentVertex.resources.filter(r => Is.empty(r.dateDeleted));
             if (Is.empty(latestRevision)) {
                 throw new NotFoundError(this.CLASS_NAME, "documentRevisionNone");
             }
@@ -638,7 +765,7 @@ class DocumentManagementService {
                     const blobStorageId = await this._blobStorageComponent.create(Converter.bytesToBase64(blob), undefined, undefined, undefined, undefined, userIdentity, nodeIdentity);
                     const newRevision = ObjectHelper.clone(latestRevision);
                     newRevision.documentRevision++;
-                    newRevision.id = `${newRevision.documentId}:${newRevision.documentRevision}`;
+                    newRevision.id = this.createDocumentId(newRevision.documentId, newRevision.documentRevision);
                     newRevision.blobHash = newBlobHash;
                     newRevision.blobStorageId = blobStorageId;
                     newRevision.annotationObject = annotationObject;
@@ -712,6 +839,43 @@ class DocumentManagementService {
             throw new GeneralError(this.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.
+     * @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.
+     */
+    async getRevision(auditableItemGraphDocumentId, revision, options, userIdentity, nodeIdentity) {
+        Urn.guard(this.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
+        Guards.integer(this.CLASS_NAME, "revision", revision);
+        try {
+            const documentVertex = await this._auditableItemGraphComponent.get(auditableItemGraphDocumentId, { includeDeleted: true });
+            if (Is.empty(documentVertex.resources)) {
+                throw new NotFoundError(this.CLASS_NAME, "documentRevisionNone");
+            }
+            documentVertex.resources = documentVertex.resources.filter(d => d.resourceObject?.documentRevision === revision);
+            if (documentVertex.resources.length === 0) {
+                throw new NotFoundError(this.CLASS_NAME, "documentRevisionNotFound", revision.toString());
+            }
+            // Populate the document and revisions with the options set
+            const docList = await this.getDocumentsFromVertex(documentVertex, options, undefined, undefined, userIdentity, nodeIdentity);
+            return JsonLdProcessor.compact(docList.documents[0], docList.documents[0]["@context"]);
+        }
+        catch (error) {
+            if (BaseError.someErrorName(error, "NotFoundError")) {
+                throw error;
+            }
+            throw new GeneralError(this.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.
@@ -959,6 +1123,7 @@ class DocumentManagementService {
             for (let i = 0; i < slicedResources.length; i++) {
                 const document = slicedResources[i].resourceObject;
                 if (Is.object(document)) {
+                    document.dateDeleted = slicedResources[i].dateDeleted;
                     docList.documents.push(document);
                     const blobRequired = includeBlobStorageMetadata || includeBlobStorageData;
                     if (blobRequired || extractData) {
@@ -1026,6 +1191,17 @@ class DocumentManagementService {
         };
         return this._attestationComponent.create(documentAttestation, undefined, userIdentity, nodeIdentity);
     }
+    /**
+     * 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}`;
+    }
 }
 
 const restEntryPoints = [
@@ -1037,4 +1213,4 @@ const restEntryPoints = [
     }
 ];
 
-export { DocumentManagementService, documentManagementCreate, documentManagementGet, documentManagementQuery, documentManagementRemove, documentManagementUpdate, generateRestRoutesDocumentManagement, restEntryPoints, tagsDocumentManagement };
+export { DocumentManagementService, documentManagementCreate, documentManagementGet, documentManagementGetRevision, documentManagementQuery, documentManagementRemove, documentManagementUpdate, generateRestRoutesDocumentManagement, restEntryPoints, tagsDocumentManagement };

package/dist/types/documentManagementRoutes.d.ts

@@ -1,5 +1,5 @@
 import type { ICreatedResponse, IHttpRequestContext, INoContentResponse, IRestRoute, ITag } from "@twin.org/api-models";
-import { type IDocumentManagementCreateRequest, type IDocumentManagementGetRequest, type IDocumentManagementGetResponse, type IDocumentManagementQueryRequest, type IDocumentManagementQueryResponse, type IDocumentManagementRemoveRequest, type IDocumentManagementUpdateRequest } from "@twin.org/document-management-models";
+import { type IDocumentManagementGetRevisionRequest, type IDocumentManagementGetRevisionResponse, type IDocumentManagementCreateRequest, type IDocumentManagementGetRequest, type IDocumentManagementGetResponse, type IDocumentManagementQueryRequest, type IDocumentManagementQueryResponse, type IDocumentManagementRemoveRequest, type IDocumentManagementUpdateRequest } from "@twin.org/document-management-models";
 /**
  * The tag to associate with the routes.
  */
@@ -28,7 +28,15 @@ export declare function documentManagementCreate(httpRequestContext: IHttpReques
  */
 export declare function documentManagementGet(httpRequestContext: IHttpRequestContext, componentName: string, request: IDocumentManagementGetRequest): Promise<IDocumentManagementGetResponse>;
 /**
- * UPdate the document from the auditable item graph vertex.
+ * Get the document revision from the auditable item graph vertex.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function documentManagementGetRevision(httpRequestContext: IHttpRequestContext, componentName: string, request: IDocumentManagementGetRevisionRequest): Promise<IDocumentManagementGetRevisionResponse>;
+/**
+ * Update the document from the auditable item graph vertex.
  * @param httpRequestContext The request context for the API.
  * @param componentName The name of the component to use in the routes.
  * @param request The request.

package/dist/types/documentManagementService.d.ts

@@ -1,6 +1,6 @@
 import { type IAuditableItemGraphVertexList } from "@twin.org/auditable-item-graph-models";
 import { type IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import { type IDocumentList, type IDocumentManagementComponent } from "@twin.org/document-management-models";
+import { type IDocument, type IDocumentList, type IDocumentManagementComponent } from "@twin.org/document-management-models";
 import { UneceDocumentCodes } from "@twin.org/standards-unece";
 import type { IDocumentManagementServiceConstructorOptions } from "./models/IDocumentManagementStorageServiceConstructorOptions";
 /**
@@ -88,6 +88,27 @@ export declare class DocumentManagementService implements IDocumentManagementCom
         extractRuleGroupId?: string;
         extractMimeType?: string;
     }, cursor?: string, pageSize?: number, userIdentity?: string, nodeIdentity?: string): Promise<IDocumentList>;
+    /**
+     * 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.
+     * @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.

package/docs/changelog.md

@@ -1,5 +1,33 @@
 # @twin.org/document-management-service - Changelog
 
+## [0.0.1-next.13](https://github.com/twinfoundation/document-management/compare/document-management-service-v0.0.1-next.12...document-management-service-v0.0.1-next.13) (2025-04-30)
+
+
+### Features
+
+* populate dateDeleted from aig resource object ([ce91cf1](https://github.com/twinfoundation/document-management/commit/ce91cf1385c4370ec6924435349213abf776f3e5))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/document-management-models bumped from 0.0.1-next.12 to 0.0.1-next.13
+
+## [0.0.1-next.12](https://github.com/twinfoundation/document-management/compare/document-management-service-v0.0.1-next.11...document-management-service-v0.0.1-next.12) (2025-04-30)
+
+
+### Features
+
+* get document revision ([080eddc](https://github.com/twinfoundation/document-management/commit/080eddcc024c622dda6bb36f60f5fa80a86cf5bb))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/document-management-models bumped from 0.0.1-next.11 to 0.0.1-next.12
+
 ## [0.0.1-next.11](https://github.com/twinfoundation/document-management/compare/document-management-service-v0.0.1-next.10...document-management-service-v0.0.1-next.11) (2025-04-28)
 
 

package/docs/open-api/spec.json

@@ -698,6 +698,191 @@
 			}
 		},
 		"/document-management/{auditableItemGraphDocumentId}/{revision}": {
+			"get": {
+				"operationId": "DocumentManagementGetRevision",
+				"summary": "Get the data for a document revision from document management",
+				"tags": [
+					"Document Management"
+				],
+				"parameters": [
+					{
+						"name": "auditableItemGraphDocumentId",
+						"description": "",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "aig:123456"
+					},
+					{
+						"name": "revision",
+						"description": "",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "1"
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"responses": {
+					"200": {
+						"description": "Response to get a document revision from an auditable item graph vertex.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Document"
+								},
+								"examples": {
+									"DocumentManagementGetRevisionResponseExample": {
+										"value": {
+											"@context": [
+												"https://schema.twindev.org/documents/",
+												"https://schema.twindev.org/common/",
+												"https://schema.org"
+											],
+											"type": "Document",
+											"id": "2721000:0",
+											"documentId": "2721000",
+											"documentIdFormat": "bol",
+											"documentCode": "unece:DocumentCodeList#705",
+											"documentRevision": 1,
+											"blobStorageId": "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
+											"blobHash": "sha256:123456",
+											"dateCreated": "2024-01-01T00:00:00Z",
+											"annotationObject": {
+												"@context": "https://schema.org",
+												"@type": "DigitalDocument",
+												"name": "myfile.pdf"
+											},
+											"nodeIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+											"userIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
+										}
+									}
+								}
+							},
+							"application/ld+json": {
+								"schema": {
+									"$ref": "#/components/schemas/Document"
+								},
+								"examples": {
+									"DocumentManagementGetRevisionResponseExample": {
+										"value": {
+											"@context": [
+												"https://schema.twindev.org/documents/",
+												"https://schema.twindev.org/common/",
+												"https://schema.org"
+											],
+											"type": "Document",
+											"id": "2721000:0",
+											"documentId": "2721000",
+											"documentIdFormat": "bol",
+											"documentCode": "unece:DocumentCodeList#705",
+											"documentRevision": 1,
+											"blobStorageId": "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
+											"blobHash": "sha256:123456",
+											"dateCreated": "2024-01-01T00:00:00Z",
+											"annotationObject": {
+												"@context": "https://schema.org",
+												"@type": "DigitalDocument",
+												"name": "myfile.pdf"
+											},
+											"nodeIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+											"userIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
+										}
+									}
+								}
+							}
+						}
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "component.error",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "component.error"
+										}
+									}
+								}
+							}
+						}
+					},
+					"404": {
+						"description": "The resource you tried to access does not exist, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/NotFoundResponse"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "NotFoundError",
+											"message": "component.error",
+											"properties": {
+												"notFoundId": "1"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "component.error"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			},
 			"delete": {
 				"operationId": "DocumentManagementRemove",
 				"summary": "Remove an document from an auditable item graph vertex",

package/docs/reference/classes/DocumentManagementService.md

@@ -288,6 +288,84 @@ The documents and revisions if requested, ordered by revision descending, cursor
 
 ***
 
+### getRevision()
+
+> **getRevision**(`auditableItemGraphDocumentId`, `revision`, `options?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`IDocument`\>
+
+Get a document revision using it's auditable item graph vertex id.
+
+#### Parameters
+
+##### auditableItemGraphDocumentId
+
+`string`
+
+The auditable item graph vertex id which contains the document.
+
+##### revision
+
+`number`
+
+The revision id for the document.
+
+##### options?
+
+Additional options for the get operation.
+
+###### includeBlobStorageMetadata?
+
+`boolean`
+
+Flag to include the blob storage metadata for the document, defaults to false.
+
+###### includeBlobStorageData?
+
+`boolean`
+
+Flag to include the blob storage data for the document, defaults to false.
+
+###### includeAttestation?
+
+`boolean`
+
+Flag to include the attestation information for the document, defaults to false.
+
+###### extractRuleGroupId?
+
+`string`
+
+If provided will extract data from the document using the specified rule group id.
+
+###### extractMimeType?
+
+`string`
+
+By default extraction will auto detect the mime type of the document, this can be used to override the detection.
+
+##### userIdentity?
+
+`string`
+
+The identity to perform the auditable item graph operation with.
+
+##### nodeIdentity?
+
+`string`
+
+The node identity to use for vault operations.
+
+#### Returns
+
+`Promise`\<`IDocument`\>
+
+The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
+
+#### Implementation of
+
+`IDocumentManagementComponent.getRevision`
+
+***
+
 ### removeRevision()
 
 > **removeRevision**(`auditableItemGraphDocumentId`, `revision`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>

package/docs/reference/functions/documentManagementGetRevision.md

@@ -0,0 +1,31 @@
+# Function: documentManagementGetRevision()
+
+> **documentManagementGetRevision**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IDocumentManagementGetRevisionResponse`\>
+
+Get the document revision from the auditable item graph vertex.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IDocumentManagementGetRevisionRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IDocumentManagementGetRevisionResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/documentManagementUpdate.md

@@ -2,7 +2,7 @@
 
 > **documentManagementUpdate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
 
-UPdate the document from the auditable item graph vertex.
+Update the document from the auditable item graph vertex.
 
 ## Parameters
 

package/docs/reference/index.md

@@ -19,6 +19,7 @@
 - [generateRestRoutesDocumentManagement](functions/generateRestRoutesDocumentManagement.md)
 - [documentManagementCreate](functions/documentManagementCreate.md)
 - [documentManagementGet](functions/documentManagementGet.md)
+- [documentManagementGetRevision](functions/documentManagementGetRevision.md)
 - [documentManagementUpdate](functions/documentManagementUpdate.md)
 - [documentManagementRemove](functions/documentManagementRemove.md)
 - [documentManagementQuery](functions/documentManagementQuery.md)

package/locales/en.json

@@ -4,10 +4,11 @@
 			"createFailed": "Failed to create document",
 			"updateFailed": "Failed to update document",
 			"getFailed": "Failed to get document",
+			"getRevisionFailed": "Failed to get document revision",
 			"removeRevision": "Failed to remove document revision",
 			"queryFailed": "Failed to query document",
 			"documentRevisionNone": "There are no revisions in the document",
-			"documentRevisionNotFound": "There is no revision number \"{revision}\" in the document",
+			"documentRevisionNotFound": "There is no revision number \"{notFoundId}\" in the document",
 			"namespaceMismatch": "The namespace in the urn \"{id}\" does not match the namespace of the Document Management component \"{namespace}\""
 		}
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/document-management-service",
-	"version": "0.0.1-next.11",
+	"version": "0.0.1-next.13",
 	"description": "Document management contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -22,7 +22,7 @@
 		"@twin.org/crypto": "next",
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/data-processing-models": "next",
-		"@twin.org/document-management-models": "0.0.1-next.11",
+		"@twin.org/document-management-models": "0.0.1-next.13",
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-models": "next",
 		"@twin.org/nameof": "next",