@twin.org/document-management-service 0.0.1-next.2 → 0.0.1-next.5

package/dist/cjs/index.cjs

@@ -130,7 +130,9 @@ function generateRestRoutesDocumentManagement(baseRouteName, componentName) {
                                     "@context": "https://schema.org",
                                     "@type": "DigitalDocument",
                                     name: "myfile.pdf"
-                                }
+                                },
+                                nodeIdentity: "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+                                userIdentity: "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
                             }
                         }
                     }
@@ -162,7 +164,9 @@ function generateRestRoutesDocumentManagement(baseRouteName, componentName) {
                                     "@context": "https://schema.org",
                                     "@type": "DigitalDocument",
                                     name: "myfile.pdf"
-                                }
+                                },
+                                nodeIdentity: "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+                                userIdentity: "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
                             }
                         }
                     }
@@ -253,7 +257,9 @@ function generateRestRoutesDocumentManagement(baseRouteName, componentName) {
                                             "@context": "https://schema.org",
                                             "@type": "DigitalDocument",
                                             name: "myfile.pdf"
-                                        }
+                                        },
+                                        nodeIdentity: "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+                                        userIdentity: "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
                                     }
                                 ]
                             }
@@ -291,7 +297,9 @@ function generateRestRoutesDocumentManagement(baseRouteName, componentName) {
                                             "@context": "https://schema.org",
                                             "@type": "DigitalDocument",
                                             name: "myfile.pdf"
-                                        }
+                                        },
+                                        nodeIdentity: "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+                                        userIdentity: "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
                                     }
                                 ]
                             }
@@ -322,7 +330,11 @@ async function documentManagementSet(httpRequestContext, componentName, request)
     core.Guards.object(ROUTES_SOURCE, "request.body", request.body);
     core.Guards.stringBase64(ROUTES_SOURCE, "request.body.blob", request.body.blob);
     const component = core.ComponentFactory.get(componentName);
-    const id = await component.set(request.pathParams.auditableItemGraphId, request.body.documentId, request.body.documentIdFormat, request.body.documentCode, core.Converter.base64ToBytes(request.body.blob), request.body.annotationObject, request.body.createAttestation, httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
+    const id = await component.set(request.pathParams.auditableItemGraphId, request.body.documentId, request.body.documentIdFormat, request.body.documentCode, core.Converter.base64ToBytes(request.body.blob), request.body.annotationObject, {
+        createAttestation: request.body.createAttestation,
+        includeIdAsAlias: request.body.includeIdAsAlias,
+        aliasAnnotationObject: request.body.aliasAnnotationObject
+    }, httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
     return {
         statusCode: web.HttpStatusCode.created,
         headers: {
@@ -455,40 +467,76 @@ class DocumentManagementService {
      * @param documentCode The code for the document type.
      * @param blob The data to create the document.
      * @param annotationObject Additional information to associate with the document.
-     * @param createAttestation Flag to create an attestation for the document, defaults to false.
+     * @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 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.
      */
-    async set(auditableItemGraphId, documentId, documentIdFormat, documentCode, blob, annotationObject, createAttestation, userIdentity, nodeIdentity) {
+    async set(auditableItemGraphId, documentId, documentIdFormat, documentCode, blob, annotationObject, options, userIdentity, nodeIdentity) {
         core.Guards.stringValue(this.CLASS_NAME, "auditableItemGraphId", auditableItemGraphId);
         core.Guards.stringValue(this.CLASS_NAME, "documentId", documentId);
         core.Guards.arrayOneOf(this.CLASS_NAME, "documentCode", documentCode, Object.values(standardsUnece.UneceDocumentCodes));
         core.Guards.uint8Array(this.CLASS_NAME, "blob", blob);
+        core.Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
+        core.Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
         try {
             const vertex = await this._auditableItemGraphComponent.get(auditableItemGraphId);
             vertex.resources = vertex.resources ?? [];
+            if (options?.includeIdAsAlias ?? false) {
+                vertex.aliases ??= [];
+                const found = vertex.aliases.find(a => a.id === documentId);
+                if (found) {
+                    found.annotationObject = options?.aliasAnnotationObject ?? found.annotationObject;
+                    found.aliasFormat = documentIdFormat ?? found.aliasFormat;
+                }
+                else {
+                    vertex.aliases.push({
+                        "@context": auditableItemGraphModels.AuditableItemGraphTypes.ContextRoot,
+                        type: auditableItemGraphModels.AuditableItemGraphTypes.Alias,
+                        id: documentId,
+                        aliasFormat: documentIdFormat,
+                        annotationObject: options?.aliasAnnotationObject
+                    });
+                }
+            }
             // Get all the docs from the AIG vertex
             const vertexDocs = this.filterDocumentsFromVertex(vertex);
             // Reduce the list to those with a matching id and code
             const matchingDocIds = this.findMatchingDocs(vertexDocs, documentId, documentCode, true);
+            const currentRevision = matchingDocIds[0];
+            let createAttestation = options?.createAttestation ?? false;
+            // If the create attestation flag is not defined we check to see if any previous
+            // revisions have an attestation and if so we create one for the new revision.
+            if (core.Is.undefined(options?.createAttestation)) {
+                createAttestation = matchingDocIds.some(d => core.Is.stringValue(d.attestationId));
+            }
             // Calculate the hash for the blob.
             const blobHash = this.generateBlobHash(blob);
-            let documentRevision;
-            if (core.Is.arrayValue(matchingDocIds) && matchingDocIds[0].blobHash === blobHash) {
-                documentRevision = matchingDocIds[0].documentRevision;
-                // If there is already a doc with the matching blob hash no need to create a new revision
-                // instead we just update the annotation object if it has changed.
-                if (!core.ObjectHelper.equal(matchingDocIds[0].annotationObject, annotationObject, false)) {
-                    matchingDocIds[0].dateModified = new Date().toISOString();
-                    matchingDocIds[0].annotationObject = annotationObject;
+            // Is the blob data the same as the current revision ?
+            if (currentRevision?.blobHash === blobHash) {
+                // Blob data matches so no need to create a new revision
+                // We update the current object if the annotation or createAttestation flag has changed.
+                let updated = false;
+                if (!core.ObjectHelper.equal(currentRevision.annotationObject, annotationObject, false)) {
+                    currentRevision.annotationObject = annotationObject;
+                    updated = true;
+                }
+                if (createAttestation && core.Is.empty(currentRevision.attestationId)) {
+                    currentRevision.attestationId = await this.createAttestation(currentRevision, userIdentity, nodeIdentity);
+                    updated = true;
+                }
+                if (updated) {
+                    currentRevision.dateModified = new Date(Date.now()).toISOString();
                     await this._auditableItemGraphComponent.update(vertex, userIdentity, nodeIdentity);
                 }
-                return matchingDocIds[0].id;
+                return currentRevision.id;
             }
             // Nothing matches the current blob hash so upload it to blob storage
             const blobStorageId = await this._blobStorageComponent.create(core.Converter.bytesToBase64(blob), undefined, undefined, undefined, undefined, userIdentity, nodeIdentity);
-            documentRevision = matchingDocIds.length;
+            const documentRevision = matchingDocIds.length;
             // We are creating a new document, if there is already docs with the same id and code we use the list length
             // to determine the next revision number.
             const document = {
@@ -505,15 +553,15 @@ class DocumentManagementService {
                 documentRevision,
                 blobStorageId,
                 blobHash,
-                dateCreated: new Date(Date.now()).toISOString()
+                annotationObject,
+                dateCreated: new Date(Date.now()).toISOString(),
+                nodeIdentity,
+                userIdentity
             };
             // If the attestation flag is set then create it
             if (createAttestation ?? false) {
-                document.attestationId = await this._attestationComponent.create(document, undefined, userIdentity, nodeIdentity);
+                document.attestationId = await this.createAttestation(document, userIdentity, nodeIdentity);
             }
-            // We assign the annotation object after the attestation was created
-            // as we don't want to include it in the attestation
-            document.annotationObject = annotationObject;
             // Add the new revision in to the AIG
             vertex.resources.push({
                 "@context": auditableItemGraphModels.AuditableItemGraphTypes.ContextRoot,
@@ -845,6 +893,29 @@ class DocumentManagementService {
         document.revisionCursor = nextRevisionCursor;
         return document;
     }
+    /**
+     * Create an attestation for the document.
+     * @param document The document to create the attestation for.
+     * @param userIdentity The identity to perform the attestation operation with.
+     * @param nodeIdentity The node identity to perform attestation operation with.
+     * @returns The attestation identifier.
+     */
+    async createAttestation(document, userIdentity, nodeIdentity) {
+        const documentAttestation = {
+            "@context": [
+                documentManagementModels.DocumentTypes.ContextRoot,
+                documentManagementModels.DocumentTypes.ContextRootCommon,
+                standardsSchemaOrg.SchemaOrgTypes.ContextRoot
+            ],
+            type: documentManagementModels.DocumentTypes.DocumentAttestation,
+            documentId: document.documentId,
+            documentCode: document.documentCode,
+            documentRevision: document.documentRevision,
+            dateCreated: document.dateCreated,
+            blobHash: document.blobHash
+        };
+        return this._attestationComponent.create(documentAttestation, undefined, userIdentity, nodeIdentity);
+    }
 }
 
 const restEntryPoints = [

package/dist/esm/index.mjs

@@ -128,7 +128,9 @@ function generateRestRoutesDocumentManagement(baseRouteName, componentName) {
                                     "@context": "https://schema.org",
                                     "@type": "DigitalDocument",
                                     name: "myfile.pdf"
-                                }
+                                },
+                                nodeIdentity: "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+                                userIdentity: "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
                             }
                         }
                     }
@@ -160,7 +162,9 @@ function generateRestRoutesDocumentManagement(baseRouteName, componentName) {
                                     "@context": "https://schema.org",
                                     "@type": "DigitalDocument",
                                     name: "myfile.pdf"
-                                }
+                                },
+                                nodeIdentity: "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+                                userIdentity: "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
                             }
                         }
                     }
@@ -251,7 +255,9 @@ function generateRestRoutesDocumentManagement(baseRouteName, componentName) {
                                             "@context": "https://schema.org",
                                             "@type": "DigitalDocument",
                                             name: "myfile.pdf"
-                                        }
+                                        },
+                                        nodeIdentity: "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+                                        userIdentity: "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
                                     }
                                 ]
                             }
@@ -289,7 +295,9 @@ function generateRestRoutesDocumentManagement(baseRouteName, componentName) {
                                             "@context": "https://schema.org",
                                             "@type": "DigitalDocument",
                                             name: "myfile.pdf"
-                                        }
+                                        },
+                                        nodeIdentity: "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+                                        userIdentity: "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
                                     }
                                 ]
                             }
@@ -320,7 +328,11 @@ async function documentManagementSet(httpRequestContext, componentName, request)
     Guards.object(ROUTES_SOURCE, "request.body", request.body);
     Guards.stringBase64(ROUTES_SOURCE, "request.body.blob", request.body.blob);
     const component = ComponentFactory.get(componentName);
-    const id = await component.set(request.pathParams.auditableItemGraphId, request.body.documentId, request.body.documentIdFormat, request.body.documentCode, Converter.base64ToBytes(request.body.blob), request.body.annotationObject, request.body.createAttestation, httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
+    const id = await component.set(request.pathParams.auditableItemGraphId, request.body.documentId, request.body.documentIdFormat, request.body.documentCode, Converter.base64ToBytes(request.body.blob), request.body.annotationObject, {
+        createAttestation: request.body.createAttestation,
+        includeIdAsAlias: request.body.includeIdAsAlias,
+        aliasAnnotationObject: request.body.aliasAnnotationObject
+    }, httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
     return {
         statusCode: HttpStatusCode.created,
         headers: {
@@ -453,40 +465,76 @@ class DocumentManagementService {
      * @param documentCode The code for the document type.
      * @param blob The data to create the document.
      * @param annotationObject Additional information to associate with the document.
-     * @param createAttestation Flag to create an attestation for the document, defaults to false.
+     * @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 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.
      */
-    async set(auditableItemGraphId, documentId, documentIdFormat, documentCode, blob, annotationObject, createAttestation, userIdentity, nodeIdentity) {
+    async set(auditableItemGraphId, documentId, documentIdFormat, documentCode, blob, annotationObject, options, userIdentity, nodeIdentity) {
         Guards.stringValue(this.CLASS_NAME, "auditableItemGraphId", auditableItemGraphId);
         Guards.stringValue(this.CLASS_NAME, "documentId", documentId);
         Guards.arrayOneOf(this.CLASS_NAME, "documentCode", documentCode, Object.values(UneceDocumentCodes));
         Guards.uint8Array(this.CLASS_NAME, "blob", blob);
+        Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
+        Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
         try {
             const vertex = await this._auditableItemGraphComponent.get(auditableItemGraphId);
             vertex.resources = vertex.resources ?? [];
+            if (options?.includeIdAsAlias ?? false) {
+                vertex.aliases ??= [];
+                const found = vertex.aliases.find(a => a.id === documentId);
+                if (found) {
+                    found.annotationObject = options?.aliasAnnotationObject ?? found.annotationObject;
+                    found.aliasFormat = documentIdFormat ?? found.aliasFormat;
+                }
+                else {
+                    vertex.aliases.push({
+                        "@context": AuditableItemGraphTypes.ContextRoot,
+                        type: AuditableItemGraphTypes.Alias,
+                        id: documentId,
+                        aliasFormat: documentIdFormat,
+                        annotationObject: options?.aliasAnnotationObject
+                    });
+                }
+            }
             // Get all the docs from the AIG vertex
             const vertexDocs = this.filterDocumentsFromVertex(vertex);
             // Reduce the list to those with a matching id and code
             const matchingDocIds = this.findMatchingDocs(vertexDocs, documentId, documentCode, true);
+            const currentRevision = matchingDocIds[0];
+            let createAttestation = options?.createAttestation ?? false;
+            // If the create attestation flag is not defined we check to see if any previous
+            // revisions have an attestation and if so we create one for the new revision.
+            if (Is.undefined(options?.createAttestation)) {
+                createAttestation = matchingDocIds.some(d => Is.stringValue(d.attestationId));
+            }
             // Calculate the hash for the blob.
             const blobHash = this.generateBlobHash(blob);
-            let documentRevision;
-            if (Is.arrayValue(matchingDocIds) && matchingDocIds[0].blobHash === blobHash) {
-                documentRevision = matchingDocIds[0].documentRevision;
-                // If there is already a doc with the matching blob hash no need to create a new revision
-                // instead we just update the annotation object if it has changed.
-                if (!ObjectHelper.equal(matchingDocIds[0].annotationObject, annotationObject, false)) {
-                    matchingDocIds[0].dateModified = new Date().toISOString();
-                    matchingDocIds[0].annotationObject = annotationObject;
+            // Is the blob data the same as the current revision ?
+            if (currentRevision?.blobHash === blobHash) {
+                // Blob data matches so no need to create a new revision
+                // We update the current object if the annotation or createAttestation flag has changed.
+                let updated = false;
+                if (!ObjectHelper.equal(currentRevision.annotationObject, annotationObject, false)) {
+                    currentRevision.annotationObject = annotationObject;
+                    updated = true;
+                }
+                if (createAttestation && Is.empty(currentRevision.attestationId)) {
+                    currentRevision.attestationId = await this.createAttestation(currentRevision, userIdentity, nodeIdentity);
+                    updated = true;
+                }
+                if (updated) {
+                    currentRevision.dateModified = new Date(Date.now()).toISOString();
                     await this._auditableItemGraphComponent.update(vertex, userIdentity, nodeIdentity);
                 }
-                return matchingDocIds[0].id;
+                return currentRevision.id;
             }
             // Nothing matches the current blob hash so upload it to blob storage
             const blobStorageId = await this._blobStorageComponent.create(Converter.bytesToBase64(blob), undefined, undefined, undefined, undefined, userIdentity, nodeIdentity);
-            documentRevision = matchingDocIds.length;
+            const documentRevision = matchingDocIds.length;
             // We are creating a new document, if there is already docs with the same id and code we use the list length
             // to determine the next revision number.
             const document = {
@@ -503,15 +551,15 @@ class DocumentManagementService {
                 documentRevision,
                 blobStorageId,
                 blobHash,
-                dateCreated: new Date(Date.now()).toISOString()
+                annotationObject,
+                dateCreated: new Date(Date.now()).toISOString(),
+                nodeIdentity,
+                userIdentity
             };
             // If the attestation flag is set then create it
             if (createAttestation ?? false) {
-                document.attestationId = await this._attestationComponent.create(document, undefined, userIdentity, nodeIdentity);
+                document.attestationId = await this.createAttestation(document, userIdentity, nodeIdentity);
             }
-            // We assign the annotation object after the attestation was created
-            // as we don't want to include it in the attestation
-            document.annotationObject = annotationObject;
             // Add the new revision in to the AIG
             vertex.resources.push({
                 "@context": AuditableItemGraphTypes.ContextRoot,
@@ -843,6 +891,29 @@ class DocumentManagementService {
         document.revisionCursor = nextRevisionCursor;
         return document;
     }
+    /**
+     * Create an attestation for the document.
+     * @param document The document to create the attestation for.
+     * @param userIdentity The identity to perform the attestation operation with.
+     * @param nodeIdentity The node identity to perform attestation operation with.
+     * @returns The attestation identifier.
+     */
+    async createAttestation(document, userIdentity, nodeIdentity) {
+        const documentAttestation = {
+            "@context": [
+                DocumentTypes.ContextRoot,
+                DocumentTypes.ContextRootCommon,
+                SchemaOrgTypes.ContextRoot
+            ],
+            type: DocumentTypes.DocumentAttestation,
+            documentId: document.documentId,
+            documentCode: document.documentCode,
+            documentRevision: document.documentRevision,
+            dateCreated: document.dateCreated,
+            blobHash: document.blobHash
+        };
+        return this._attestationComponent.create(documentAttestation, undefined, userIdentity, nodeIdentity);
+    }
 }
 
 const restEntryPoints = [

package/dist/types/documentManagementService.d.ts

@@ -29,12 +29,19 @@ export declare class DocumentManagementService implements IDocumentManagementCom
      * @param documentCode The code for the document type.
      * @param blob The data to create the document.
      * @param annotationObject Additional information to associate with the document.
-     * @param createAttestation Flag to create an attestation for the document, defaults to false.
+     * @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 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.
      */
-    set(auditableItemGraphId: string, documentId: string, documentIdFormat: string | undefined, documentCode: UneceDocumentCodes, blob: Uint8Array, annotationObject?: IJsonLdNodeObject, createAttestation?: boolean, userIdentity?: string, nodeIdentity?: string): Promise<string>;
+    set(auditableItemGraphId: string, documentId: string, documentIdFormat: string | undefined, documentCode: UneceDocumentCodes, blob: Uint8Array, annotationObject?: IJsonLdNodeObject, options?: {
+        createAttestation?: boolean;
+        includeIdAsAlias?: 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.
@@ -87,4 +94,12 @@ export declare class DocumentManagementService implements IDocumentManagementCom
         includeMostRecentRevisions?: boolean;
         includeRemoved?: boolean;
     }, cursor?: string, userIdentity?: string, nodeIdentity?: string): Promise<IDocumentList>;
+    /**
+     * Create an attestation for the document.
+     * @param document The document to create the attestation for.
+     * @param userIdentity The identity to perform the attestation operation with.
+     * @param nodeIdentity The node identity to perform attestation operation with.
+     * @returns The attestation identifier.
+     */
+    private createAttestation;
 }

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/document-management-service - Changelog
 
-## v0.0.1-next.2
+## v0.0.1-next.5
 
 - Initial Release

package/docs/open-api/spec.json

@@ -249,7 +249,9 @@
 														"@context": "https://schema.org",
 														"@type": "DigitalDocument",
 														"name": "myfile.pdf"
-													}
+													},
+													"nodeIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+													"userIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
 												}
 											]
 										}
@@ -288,7 +290,9 @@
 														"@context": "https://schema.org",
 														"@type": "DigitalDocument",
 														"name": "myfile.pdf"
-													}
+													},
+													"nodeIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+													"userIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
 												}
 											]
 										}
@@ -485,7 +489,9 @@
 												"@context": "https://schema.org",
 												"@type": "DigitalDocument",
 												"name": "myfile.pdf"
-											}
+											},
+											"nodeIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+											"userIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
 										}
 									}
 								}
@@ -515,7 +521,9 @@
 												"@context": "https://schema.org",
 												"@type": "DigitalDocument",
 												"name": "myfile.pdf"
-											}
+											},
+											"nodeIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+											"userIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
 										}
 									}
 								}
@@ -965,6 +973,14 @@
 						"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."
+					},
 					"revisions": {
 						"type": "array",
 						"items": {
@@ -986,7 +1002,9 @@
 					"documentRevision",
 					"blobStorageId",
 					"blobHash",
-					"dateCreated"
+					"dateCreated",
+					"nodeIdentity",
+					"userIdentity"
 				],
 				"additionalProperties": false,
 				"description": "Interface describing a document."
@@ -1061,6 +1079,13 @@
 					"createAttestation": {
 						"type": "boolean",
 						"description": "Flag to create an attestation for the document, defaults to false"
+					},
+					"includeIdAsAlias": {
+						"type": "boolean",
+						"description": "Include the document id as an alias to the aig vertex, defaults to false."
+					},
+					"aliasAnnotationObject": {
+						"$ref": "#/components/schemas/JsonLdNodeObject"
 					}
 				},
 				"required": [

package/docs/reference/classes/DocumentManagementService.md

@@ -50,7 +50,7 @@ Runtime name for the class.
 
 ### set()
 
-> **set**(`auditableItemGraphId`, `documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject`?, `createAttestation`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
+> **set**(`auditableItemGraphId`, `documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject`?, `options`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
 
 Store a document in 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.
@@ -94,12 +94,28 @@ The data to create the document.
 
 Additional information to associate with the document.
 
-##### createAttestation?
+##### options?
+
+Additional options for the set operation.
+
+###### createAttestation?
 
 `boolean`
 
 Flag to create an attestation for the document, defaults to false.
 
+###### includeIdAsAlias?
+
+`boolean`
+
+Include the document id as an alias to the aig vertex, defaults to false.
+
+###### aliasAnnotationObject?
+
+`IJsonLdNodeObject`
+
+Additional information to associate with the alias.
+
 ##### userIdentity?
 
 `string`

package/package.json

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